Skip to content

Configuration

The CLI stores configuration at:

~/.hypedoc/config.json
FieldTypeDescription
tokenstringYour API token
api_urlstringCustom API base URL (for self-hosting or development)

Example:

{
"token": "hdoc_xxxxxxxxxxxxxxxxxxxx",
"api_url": "https://app.myhypedoc.com/api/v1"
}

The config file is created with 0600 permissions (readable only by you).

Environment variables override config file values:

VariableDescription
HYPEDOC_TOKENAPI token (overrides token in config)
HYPEDOC_API_URLAPI base URL (overrides api_url in config)
Terminal window
export HYPEDOC_TOKEN=hdoc_xxxxxxxxxxxxxxxxxxxx
hype log "Deployed v2.1.0 to production" --space Work --tags deploy

If no api_url is configured, the CLI connects to:

https://app.myhypedoc.com/api/v1