Skip to main content

Configuration

Aether CLI supports configuration through both environment variables and config-file keys.

The exact layout may evolve, but the main user-facing pattern is stable:

  • Use environment variables for shells, CI, and quick overrides.
  • Use config for durable local preferences.

High-signal settings​

Endpoint and identity​

  • AFS_AETHER_SERVER_ENDPOINT or [bridge].server_endpoint
  • AFS_AETHER_WORKER_ID or [bridge].worker_id

Cache locations​

  • AFS_AETHER_CACHE_DIR or cache_dir
  • AFS_AETHER_CACHE_SHARED_ROOT or shared_cache_root

Logging​

  • AFS_AETHER_LOG or log_level
  • AFS_AETHER_LOG_FORMAT or [logging].format

Metrics​

  • AFS_AETHER_CLIENT_METRICS_ADDR or metrics_addr

Metadata and lookup TTL behavior​

  • AFS_AETHER_LOOKUP_TTL_SECS or lookup_ttl_secs
  • AFS_AETHER_NEGATIVE_LOOKUP_TTL_SECS or negative_lookup_ttl_secs
  • AFS_AETHER_DIR_CACHE_TTL_SECS or dir_cache_ttl_secs

Example configuration​

[bridge]
server_endpoint = "https://grpc.aetherfs.io"
worker_id = "alice-laptop"

[logging]
format = "text"

cache_dir = "/home/alice/.cache/aether"
shared_cache_root = "/home/alice/.cache/aether-shared"
log_level = "info"
metrics_addr = "127.0.0.1:9464"
lookup_ttl_secs = 5
negative_lookup_ttl_secs = 2
dir_cache_ttl_secs = 5

Adjust the actual values for your machine and deployment.

Environment override example​

export AFS_AETHER_SERVER_ENDPOINT='https://grpc.aetherfs.io'
export AFS_AETHER_CACHE_DIR="$HOME/.cache/aether"
export AFS_AETHER_LOG='debug'
export AFS_AETHER_LOG_FORMAT='json'
export AFS_AETHER_CLIENT_METRICS_ADDR='127.0.0.1:9464'

When to prefer env vars​

Prefer env vars when:

  • Running in CI.
  • Testing temporary settings.
  • Switching between multiple environments.
  • Launching Aether CLI from wrappers or automation.

When to prefer config​

Prefer config when:

  • You want stable local defaults.
  • You use the same endpoint repeatedly.
  • You want durable logging or cache preferences.
  • You want a consistent developer-machine setup.

Deep reference​

For the full generated list of documented Aether CLI environment variables, see Aether CLI environment variables.