Configuration
Config file
Section titled “Config file”The CLI stores configuration at:
~/.hypedoc/config.jsonFields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
token | string | Your API token |
api_url | string | Custom 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
Section titled “Environment variables”Environment variables override config file values:
| Variable | Description |
|---|---|
HYPEDOC_TOKEN | API token (overrides token in config) |
HYPEDOC_API_URL | API base URL (overrides api_url in config) |
CI/CD example
Section titled “CI/CD example”export HYPEDOC_TOKEN=hdoc_xxxxxxxxxxxxxxxxxxxxhype log "Deployed v2.1.0 to production" --space Work --tags deployDefault API URL
Section titled “Default API URL”If no api_url is configured, the CLI connects to:
https://app.myhypedoc.com/api/v1