CLI overview

Install

The Doxynix CLI is a single binary available as both dxnx and doxynix. Build it from the repository, as described in Install the CLI. The published npm package can lag behind the current code, so build from source when you need the exact behaviour of this documentation.

Authenticate

dxnx login
dxnx login --token "$DOXYNIX_API_KEY"
dxnx me
dxnx logout

dxnx login prompts for an API key, verifies it against the API and saves it. --token skips the prompt, which is what you want in a script. dxnx me prints the current account (whoami is an alias), and dxnx logout removes the local credentials. Tokens supplied through the environment survive logout, so unset them as well when you really want to sign out.

Configuration

The token lives in ~/.config/dxnx/config.json with 0600 permissions. XDG_CONFIG_HOME relocates that directory on every platform, and Windows uses %APPDATA%\dxnx\config.json. These environment variables take precedence over the file:

• DOXYNIX_API_KEY — API key, read first.
• DXNX_TOKEN — alternative API key variable.
• DOXYNIX_API_URL — API root including /api; defaults to https://doxynix.space/api.

Machine-readable output

Many commands accept --json and print a single JSON document to stdout. Parse that output in scripts and CI; the colored human output is meant for terminals and its shape is not stable.

Command map

CI recipe

Set the key inline or inject it from your CI secret store; the CLI reads DOXYNIX_API_KEY. analyze start only dispatches the job, so run the remaining commands after the run finishes.

export DOXYNIX_API_KEY="dxnx_your_key_here"
dxnx analyze start owner/repo --branch "$GITHUB_REF_NAME"
# GitLab: dxnx analyze start owner/repo --branch "$CI_COMMIT_REF_NAME"

# After the run finishes:
dxnx analyze status owner/repo
dxnx docs export owner/repo --dir ./docs

The same flow is packaged as a GitHub Action: doxynix/action (uses: doxynix/action@v1), documented in GitHub Action.