Configuration Reference

Complete reference for all context configuration options.

Root Fields

Field	Type	Description
name	string	Required. Unique context identifier
description	string	Human-readable description
environment	string	Environment type: development, staging, production
extends	string	Parent context name to inherit from
abstract	bool	If true, context cannot be used directly
env_color	string	Prompt color: red, yellow, green, blue, cyan, magenta, white
tags	[]string	Tags for filtering and organization

AWS

aws:
  profile: string           # AWS CLI profile name
  region: string            # AWS region (us-east-1, eu-west-1, etc.)
  sso_login: bool           # Auto-run 'aws sso login' on context switch
  use_vault: bool           # Use aws-vault for temporary credentials

See AWS Provider for details.

GCP

gcp:
  project: string           # GCP project ID
  region: string            # GCP region
  config_name: string       # gcloud configuration name
  auto_login: bool          # Auto-run 'gcloud auth login'

See GCP Provider for details.

Azure

azure:
  subscription_id: string   # Azure subscription ID
  tenant_id: string         # Azure tenant ID
  auto_login: bool          # Auto-run 'az login'

See Azure Provider for details.

Kubernetes

kubernetes:
  context: string           # kubectl context name
  namespace: string         # Default namespace
  kubeconfig: string        # Path to kubeconfig file (optional)

Nomad

nomad:
  address: string           # Nomad server address (https://nomad:4646)
  namespace: string         # Nomad namespace
  skip_verify: bool         # Skip TLS verification

Consul

consul:
  address: string           # Consul server address (https://consul:8500)

SSH

ssh:
  bastion:
    host: string            # Bastion hostname
    port: int               # SSH port (default: 22)
    user: string            # SSH username
    identity_file: string   # Path to SSH private key

Tunnels

tunnels:
  - name: string            # Tunnel identifier
    description: string     # Human-readable description
    local_port: int         # Local port to bind
    remote_host: string     # Remote host to tunnel to
    remote_port: int        # Remote port
    auto_connect: bool      # Start automatically on context switch

See SSH Tunnels for details.

VPN

vpn:
  type: string              # openvpn, wireguard, tailscale, custom
  config_file: string       # Path to VPN config file
  interface: string         # WireGuard interface name
  exit_node: string         # Tailscale exit node
  connect_cmd: string       # Custom connect command
  disconnect_cmd: string    # Custom disconnect command
  status_cmd: string        # Custom status command
  auth_user_pass: string    # OpenVPN credentials file
  auto_connect: bool        # Connect on context switch
  auto_disconnect: bool     # Disconnect when switching away

See VPN for details.

Vault

vault:
  address: string           # Vault server address
  namespace: string         # Vault namespace
  auth_method: string       # token, oidc, aws, kubernetes, approle
  auto_login: bool          # Auto-run 'vault login'
  skip_verify: bool         # Skip TLS verification

See HashiCorp Vault for details.

Bitwarden

bitwarden:
  auto_login: bool          # Auto-run 'bw login' if not authenticated
  sso: bool                 # Use SSO login

1Password

onepassword:
  auto_login: bool          # Auto-run 'op signin' if not authenticated
  account: string           # 1Password account URL

Secrets

secrets:
  bitwarden:
    ENV_VAR_NAME: "item-name"     # Bitwarden item name
  onepassword:
    ENV_VAR_NAME: "item-name"     # 1Password item name
  vault:
    ENV_VAR_NAME: "path#field"    # Vault path and field

See Secrets Management for details.

Git

git:
  user_name: string         # Git author/committer name
  user_email: string        # Git author/committer email
  signing_key: string       # GPG key ID for signing
  gpg_sign: bool            # Enable commit signing

Docker

docker:
  url: string               # Docker registry URL
  context: string           # Docker context name

NPM

npm:
  registry: string          # NPM registry URL
  scope: string             # NPM scope (@mycompany)

Databases

databases:
  - name: string            # Database identifier
    type: string            # postgres, mysql, mongodb, redis
    host: string            # Database host
    port: int               # Database port
    database: string        # Database name
    username: string        # Database username
    ssl_mode: string        # SSL mode (postgres)

Proxy

proxy:
  http: string              # HTTP proxy URL
  https: string             # HTTPS proxy URL
  no_proxy: string          # Comma-separated bypass list

See Proxy Configuration for details.

Browser

browser:
  type: string              # chrome or firefox
  profile: string           # Browser profile name

See Browser Profiles for details.

URLs

urls:
  name: string              # URL for 'ctx open name'

Environment Variables

env:
  VAR_NAME: value           # Custom environment variable

Deactivate Behavior

deactivate:
  disconnect_vpn: bool      # Disconnect VPN on deactivate (default: true)
  stop_tunnels: bool        # Stop tunnels on deactivate (default: true)