Configuration
Customize apix behavior, sources, and environment variables.
Config File
apix reads its configuration from ~/.apix/config.toml. Running apix init creates this file with sensible defaults.
color = true
pager = ""
auto_update = true
auto_update_ttl_seconds = 21600
sources = [".local", "core"]
[registry]
remote = "https://github.com/apix-sh/vault.git"Options
| Key | Type | Default | Description |
|---|---|---|---|
color | bool | true | Enable colored output |
pager | string | "" | Custom pager command (fallback: less -FRX) |
auto_update | bool | true | Auto-refresh registry on search |
auto_update_ttl_seconds | int | 21600 | Seconds between auto-updates (0 disables) |
sources | list | [".local", "core"] | Source priority order |
registry.remote | string | GitHub vault URL | Default registry remote |
Adding Third-Party Sources
Register a custom vault repository:
[source.acme]
remote = "https://github.com/acme/apix-vaults.git"Then update your source priority:
sources = [".local", "core", "acme"]Private Repositories
apix uses your system's git command for all vault operations. This means it
automatically inherits your local Git authentication (SSH keys, credential
managers, or tokens). You can maintain and use private API vaults as long as
your local Git has the rights to access them.
Or manage sources with the CLI:
apix source add acme --remote https://github.com/acme/apix-vaults.git
apix source listEnvironment Variables
Environment variables override their config file counterparts:
| Variable | Overrides | Description |
|---|---|---|
APIX_HOME | ~/.apix | Home directory path |
APIX_REGISTRY_URL | registry.remote | Default registry remote URL |
APIX_AUTO_UPDATE | auto_update | Enable/disable auto-update |
APIX_AUTO_UPDATE_TTL_SECONDS | auto_update_ttl_seconds | Auto-update interval |
APIX_SOURCES | sources | Comma-separated source priority |
NO_COLOR | color | Disable color output |
PAGER | pager | Pager command |
Stateless by design
apix does not store global HTTP state, default headers, or credentials in the
config file. Authentication must be passed explicitly to each apix call
invocation. This ensures predictable, side-effect-free execution — especially
important for agent workflows.
Directory Layout
~/.apix/
├── config.toml # Configuration file
└── vaults/
├── .local/ # Locally imported APIs
│ └── <namespace>/
│ └── <version>/
├── core/ # Public curated registry
│ ├── registry.json
│ └── <namespace>/
└── <custom-source>/ # Third-party registries
├── registry.json
└── <namespace>/