Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt

Use this file to discover all available pages before exploring further.

The Jamdesk CLI uses three commands to manage authentication: jamdesk login to sign in, jamdesk logout to sign out, and jamdesk whoami to verify who the CLI is currently authenticated as. Credentials are stored locally in ~/.jamdeskrc and are required for commands that communicate with the Jamdesk platform, such as jamdesk deploy.

jamdesk login

jamdesk login
Running jamdesk login opens your browser to dashboard.jamdesk.com/cli-auth. At the same time, the CLI starts a local callback server on 127.0.0.1:9876 to receive the authentication token when you complete the login flow. If port 9876 is already in use, the CLI falls back to an OS-assigned port automatically. All login methods available on the dashboard are supported: email and password, Google, and GitHub. The login flow has a 2-minute timeout. If it expires before you complete authentication, run jamdesk login again.

Headless and SSH environments

In headless or SSH environments where a browser cannot be opened automatically, the authentication URL is always printed to the terminal. Copy the URL and open it in any browser to complete the login flow.

jamdesk logout

jamdesk logout
jamdesk logout clears your stored credentials from ~/.jamdeskrc. If you are not currently logged in, the command exits silently without error.

jamdesk whoami

jamdesk whoami
jamdesk whoami displays the email address of the currently authenticated account. Unlike a simple local cache read, it validates the session by attempting a token refresh against the Jamdesk API. If the token cannot be refreshed, the command reports that the session has expired — run jamdesk login again to re-authenticate.

Credential storage

Credentials are written to ~/.jamdeskrc with 0600 permissions (owner read/write only), so no other users on the system can read your authentication token.

Flags

All three authentication commands support the --verbose flag for detailed output:
FlagDescription
--verbosePrint detailed output during the operation
Run jamdesk whoami at the start of a deploy script to confirm the session is valid before the deploy begins. This catches an expired token early and avoids a failed deployment midway through.

Build docs developers (and LLMs) love