Install the CLI and sign in

Install the ghaym command, sign it in with an API key, and check who it acts as.

Install it

  1. Install Node.js 24 or later, then install the CLI from npm:
    Terminal
    npm install -g @ghaymjo/cli
  2. Check which version you have.

    The CLI reference names the version these pages describe.

    With the CLI:

    Terminal
    ghaym --version
  3. If yours is older, or a command on these pages is unknown to it, update it:
    Terminal
    npm install -g @ghaymjo/cli@latest

Sign in

  1. Create an API key.

    It starts with ghk_.

  2. Run ghaym login and paste the key.

    It doesn't show as you paste, and the CLI checks it before saving it.

    With the CLI:

    Terminal
    ghaym login
  3. In non-interactive environments, where no one can run ghaym login, put the key in a GHAYM_TOKEN environment variable.

    When it is set, the CLI uses it over a saved key.

    With the CLI:

    Terminal
    export GHAYM_TOKEN=<key>

Check who it acts as

ghaym whoami prints the account's email, where the key came from, and what it may do. ghaym logout removes the saved key from this machine; the key itself stays valid until you revoke it.

Terminal
ghaym whoami