Skip to main content

Canine CLI

The Canine CLI (canine) is a command-line tool for interacting with your Canine deployments directly from your terminal.

Features

  • Authentication - Secure API token-based authentication with multi-account support
  • Project Management - List, deploy, and manage your projects
  • Run Commands - Run any command in your project's environment
  • Cluster Access - Download kubeconfig files for direct kubectl access
  • Build Management - View build status and cancel running builds

Quick Install

macOS (Homebrew)

brew tap caninehq/canine
brew install canine

Linux

curl -sSL https://raw.githubusercontent.com/CanineHQ/cli/main/install.sh | sh

Getting Started

After installation, authenticate with your API token:

canine auth login --token <YOUR_API_TOKEN>

Verify you're logged in:

canine auth status

List your projects:

canine projects list

Command Overview

CommandDescription
canine authManage authentication (login, logout, status)
canine accountsSwitch between accounts
canine projectsManage projects (list, deploy, run, logs, processes)
canine clustersManage clusters (list, kubeconfig, connect)
canine buildsView and manage builds (list, kill)
canine add-onsManage add-ons (list, restart)
canine localRun Canine locally with Docker Compose

See the individual command pages for detailed usage.