Configuration
Configuration
outline-cli uses a YAML config file at ~/.outline-cli/config.yaml with OS keyring for secrets.
Custom Config File Location
Override the config path with --config:
outline --config ./my-config.yaml push --path ./docs/ --collection-id "Docs"If you use a project-local config file, add it to
.gitignore — it may contain secrets when token_storage=file is set.Commands
outline config set server_url https://outline.example.com
outline config get server_url
outline config list
outline config pathAvailable Keys
| Key | Values | Description |
|---|---|---|
server_url | URL | Outline server URL |
auth_method | oidc, api-token, basic | Authentication method for auto-auth |
token_storage | keyring, file | Where to store secrets |
oidc_port | 1–65535 | Local port for OIDC callback |
api_token | string | API token (stored in keyring) |
password | string | Basic auth password (stored in keyring) |
Secret Storage
Keys api_token and password are stored in the OS keyring by default:
outline config set api_token sk-abc123
# → stored in libsecret/Keychain/Credential Manager, NOT in config.yamlFor headless environments (CI, containers) where keyring is unavailable:
outline config set token_storage file
outline config set api_token sk-abc123
# → stored in config.yaml (0600 permissions)Config File Format
server_url: https://outline.example.com
auth_method: oidc
token_storage: keyring
oidc_port: 10800