The CLI signs in through the browser and stores a session per workspace. It does
not use the X-Api-Key header that the REST API
uses, so there is no API key to create or rotate for CLI use.
Sign in
Without --subdomain the command asks for it:
The subdomain is the first part of your workspace URL. If you sign in to
NeetoRecord at acme.neetorecord.com, the subdomain is acme. See
Workspace subdomain.
login opens your browser to complete the sign in and writes the resulting
session to ~/.config/neetorecord/auth.json. Running it again for the same
subdomain refreshes that entry.
Check who you are signed in as
With several workspaces signed in, whoami lists all of them, and
neetorecord whoami --subdomain acme shows just one.
Working with several workspaces
auth.json holds one entry per subdomain. Which one a command uses depends on
how many are signed in:
Sign out
neetorecord logout with no flags signs out of the only workspace when
exactly one is signed in, and errors when several are. --all signs out of
every workspace at once.
Check connectivity
doctor reports authentication, API reachability, and the CLI version in one
go. It is the first thing to run when a command fails for a reason you cannot
place.
Point the CLI at another environment
Set NEETORECORD_BASE_URL to override the default
https://<subdomain>.neetorecord.com host. This is meant for local and staging
servers.