story: move CHECKLY prefixed envs to AuthCommand base class so they are documented

[umutuzgur]

Story description

We have 2 special env vars for bypassing the auth flow which we use heavily with the CI use case. We are not using the oclif framework to set this env vars which then causes it not to be printed when a user invokes the --help command. Instead, we should move these to the AuthCommand so they are documented and easier to be discovered by the user

Shortcut link

No response

Additional resources

No response

[nahuelon]

I tried to add the env variables to the flags but the --help doesn't show any environment variable description. I found someone that is asking for that feature in oclif/core#981

[tnolet]

@umutuzgur is this still relevant?

[umutuzgur]

@tnolet yeah

[nahuelon]

@umutuzgur , @tnolet , yesterday I tried to move the --api-key and --account-id flags to the AuthCommand class. That made them available for all the commands that required authentication and let the users send their credentials in one line command (f.ex. run test without any previous login or env var configuration). Let me know what you think about this behavior. I know this is not what we should do here but I tried to use oclif env var definition and they weren't shown in the --help information output (issue here)
Can you suggest me a potential --help output so I can tweak the help output. Thanks.

[tnolet]

no, this is an antipattern. We should not have flags to set credentials. You cannot encourage users to visibly set credentials in a command line app which will be logged by CI systems etc. They should always be ENV VARS.

[nahuelon]

no, this is an antipattern. We should not have flags to set credentials. You cannot encourage users to visibly set credentials in a command line app which will be logged by CI systems etc. They should always be ENV VARS.

@tnolet , I agree. And, is it OK to keep the flags for the login?

[tnolet]

no, this is an antipattern. We should not have flags to set credentials. You cannot encourage users to visibly set credentials in a command line app which will be logged by CI systems etc. They should always be ENV VARS.

@tnolet , I agree. And, is it OK to keep the flags for the login?

No, no flag at all. Login is interactive. If you don't want interactive, use env vars.

[nahuelon]

I created checkly/docs.checklyhq.com#813 to add the CHECKLY_ACCOUNT_NAME description to the /docs