Skip to main content
Signing in lets the command line use your Iris Code Pro licence. Without it, Pro commands skip and the Free commands still work. On your own machine, run iris auth login and choose to sign in through your browser or paste a licence token. On an automated runner, where nobody is there to answer a prompt, store the licence as a secret called IRIS_LICENCE_TOKEN so the check can run without logging in.

The commands

iris auth login asks whether you want to sign in through the browser or paste a token. It needs an interactive terminal. When there is none, it reports an error rather than waiting forever for an answer.
iris auth status shows your plan, where the licence was read from, and whether an organisation or repository policy has turned the agent handoff off for you.

How credentials are stored

Both the browser sign-in and the pasted token are saved to ~/.iris/credentials. The file is created with chmod 600, so only your user account can read it.
Add ~/.iris/ to your global gitignore so the credentials can never be committed to a repository by accident.

Priority order

When both are present, the CLI uses the first one it finds:
  1. The IRIS_LICENCE_TOKEN environment variable: checked first, and used instead of the credentials file.
  2. The credentials file at ~/.iris/credentials: written by iris auth login, whichever method (browser or pasted token) you chose at the prompt.

Using IRIS_LICENCE_TOKEN in CI

The environment variable is the recommended way to sign in on a CI runner. Nothing is written to the runner’s disk, and you can cut off access by replacing the secret in your repository settings.
To use the token in a CI pipeline:
  1. Add your licence key as a repository secret named IRIS_LICENCE_TOKEN in your CI provider’s settings.
  2. Pass that secret as the IRIS_LICENCE_TOKEN environment variable in the workflow step that runs Iris Code.
  3. The CLI reads the variable automatically, so the runner needs no iris auth login step.
iris secrets and iris security need no sign-in at all. Both are Free and need no licence, so you can run either in any pipeline without setting IRIS_LICENCE_TOKEN.