Configuration
Configuration
Section titled “Configuration”atlcli can be configured through config files, environment variables, and command-line flags.
Config File
Section titled “Config File”Global configuration is stored at ~/.atlcli/config.json:
{ "defaultProfile": "work", "logging": { "level": "info", "file": "~/.atlcli/atlcli.log" }, "plugins": { "enabled": ["git"], "path": "~/.atlcli/plugins" }}Settings
Section titled “Settings”Default Profile
Section titled “Default Profile”Set the default authentication profile:
{ "defaultProfile": "work"}Override with --profile flag or ATLCLI_PROFILE environment variable.
Logging
Section titled “Logging”Configure logging behavior:
{ "logging": { "level": "debug", "file": "/var/log/atlcli.log" }}| Option | Values | Default |
|---|---|---|
level | debug, info, warn, error | info |
file | Path to log file | None (stdout only) |
Plugins
Section titled “Plugins”Configure the plugin system:
{ "plugins": { "enabled": ["git", "custom-workflow"], "path": "~/.atlcli/plugins" }}See Using Plugins for details.
Storage
Section titled “Storage”Configure the sync database backend:
{ "storage": { "adapter": "sqlite", "sqlite": { "enableVectors": false } }}| Option | Values | Default |
|---|---|---|
adapter | sqlite, json | sqlite |
sqlite.enableVectors | Enable vector search | false |
See Storage for details.
Configure sync behavior:
{ "sync": { "userStatusTtlDays": 7, "skipUserStatusCheck": false, "postPullAuditSummary": false }}| Option | Description | Default |
|---|---|---|
userStatusTtlDays | Days before re-checking user status | 7 |
skipUserStatusCheck | Skip user status updates during pull | false |
postPullAuditSummary | Show audit summary after pull | false |
Configure content audit defaults:
{ "audit": { "staleThresholds": { "high": 12, "medium": 6, "low": 3 }, "defaultChecks": [ "stale", "orphans", "broken-links" ] }}| Option | Description | Default |
|---|---|---|
staleThresholds.high | Months for high-risk stale | - |
staleThresholds.medium | Months for medium-risk stale | - |
staleThresholds.low | Months for low-risk stale | - |
defaultChecks | Checks to run by default | [] |
Valid defaultChecks values: stale, orphans, broken-links, single-contributor, inactive-contributors, external-links
See Audit for details.
Projects
Section titled “Projects”Register projects for cross-project operations:
{ "projects": [ { "path": "/home/user/docs/.atlcli", "space": "DOCS", "label": "Documentation" }, { "path": "/home/user/wiki/.atlcli", "space": "TEAM", "label": "Team Wiki" } ]}| Option | Description |
|---|---|
path | Path to project’s .atlcli directory |
space | Confluence space key |
project | Jira project key (optional) |
label | Display label (optional) |
Environment Variables
Section titled “Environment Variables”| Variable | Description |
|---|---|
ATLCLI_BASE_URL | Atlassian instance URL |
ATLCLI_EMAIL | Account email |
ATLCLI_API_TOKEN | API token |
ATLCLI_PROFILE | Default profile |
ATLCLI_LOG_LEVEL | Logging level |
ATLCLI_CONFIG | Path to config file |
Environment variables override config file settings.
Project Configuration
Section titled “Project Configuration”For Confluence sync, project-specific config is stored in .atlcli.json within the synced directory:
{ "space": "TEAM", "rootPageId": "12345", "ignorePaths": ["drafts/**", "*.tmp"], "syncOptions": { "deleteOrphans": false, "preserveLocalChanges": true }}Precedence
Section titled “Precedence”Settings are applied in this order (later overrides earlier):
- Built-in defaults
- Global config file (
~/.atlcli/config.json) - Project config file (
.atlcli.json) - Environment variables
- Command-line flags
Examples
Section titled “Examples”CI/CD Optimized Config
Section titled “CI/CD Optimized Config”{ "logging": { "level": "warn" }}Development Config
Section titled “Development Config”{ "logging": { "level": "debug", "file": "~/.atlcli/debug.log" }, "defaultProfile": "dev"}Related Topics
Section titled “Related Topics”- Authentication - Profile and credential setup
- Using Plugins - Plugin configuration
- Environment Variables - Full environment variable reference