Install the CLI and sign in
Install the ghaym command, sign it in with an API key, and check who it acts as.
All pages
- Install Node.js 24 or later, then install the CLI from npm:Terminal
npm install -g @ghaymjo/cli - Check which version you have.
The CLI reference names the version these pages describe.
With the CLI:
Terminalghaym --version - If yours is older, or a command on these pages is unknown to it, update it:Terminal
npm install -g @ghaymjo/cli@latest
- Create an API key.
It starts with
ghk_. - Run
ghaym loginand paste the key.It doesn't show as you paste, and the CLI checks it before saving it.
With the CLI:
Terminalghaym login - In non-interactive environments, where no one can run
ghaym login, put the key in aGHAYM_TOKENenvironment variable.When it is set, the CLI uses it over a saved key.
With the CLI:
Terminalexport GHAYM_TOKEN=<key>
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