CLI Configuration

Configure the MUXI CLI settings and server profiles

The CLI stores server profiles, formation credentials, and local defaults in ~/.muxi/cli/.

Configuration Files

~/.muxi/cli/
├── profiles.yaml    # Server URLs and server API credentials
├── formations.yaml  # Saved formation credentials and defaults
└── defaults.yaml    # Default user ID and file extension

Local Defaults

~/.muxi/cli/defaults.yaml:

version: "1.0"
user_id: user_123
file_extension: afs

Settings Reference

Setting Default Description
user_id unset Default user for user-scoped commands
file_extension afs File extension generated by scaffolding (afs or yaml)

Server Profiles

~/.muxi/cli/profiles.yaml:

version: "1.0"
default: local
profiles:
  local:
    url: http://localhost:7890
    key_id: MUXI_local
    secret_key: sk_...

  staging:
    url: https://staging.example.com:7890
    key_id: MUXI_staging
    secret_key: sk_...

  production:
    url: https://muxi.example.com:7890
    key_id: MUXI_production
    secret_key: sk_...

Managing Profiles

# Add a profile
muxi profiles add production

# List profiles
muxi profiles list

# Switch default
muxi set default profile production

# Remove profile
muxi profiles remove old-server

Using Profiles

# Use default profile
muxi deploy

# Use specific profile
muxi deploy --profile production

# Override for one command
muxi remote list --profile staging

Each profile identifies one MUXI Server. Use --profile to override the saved default for commands that accept a profile flag.

Next Steps


Home Docs SDKs
Star on GitHub