Skip to main content

Configuration

The Canine CLI stores its configuration in ~/.canine/.

Configuration Files

FilePurpose
~/.canine/canine.yamlAuthentication and account settings
~/.canine/kubeconfig.yamlKubernetes cluster credentials

canine.yaml

The main configuration file stores your authentication credentials:

host: https://canine.sh
token: your-api-token
account: my-team
FieldDescription
hostAPI endpoint (default: https://canine.sh)
tokenYour API authentication token
accountCurrently selected account slug

This file is created automatically when you run canine auth login.

kubeconfig.yaml

This file stores Kubernetes cluster credentials downloaded via:

  • canine clusters download-kubeconfig
  • canine projects run (downloads automatically)

The format follows the standard Kubernetes kubeconfig schema.

Custom API Host

For self-hosted Canine installations, specify a custom host during login:

canine auth login --token <TOKEN> --host https://canine.example.com

Directory Structure

~/.canine/
├── canine.yaml # Auth credentials
├── kubeconfig.yaml # Cluster credentials
└── src/ # Local environment (created by `canine local start`)
├── docker-compose.yml
└── .env

Clearing Configuration

To remove all CLI configuration:

canine auth logout
rm -rf ~/.canine

Security Considerations

  • The canine.yaml file contains your API token. Keep it secure.
  • The kubeconfig.yaml file contains cluster credentials. Treat it as sensitive.
  • Both files are stored with default file permissions. Consider restricting access:
chmod 600 ~/.canine/canine.yaml
chmod 600 ~/.canine/kubeconfig.yaml