Canary CLI Setup

Installation

Install with pipxInstall with pipx from RepoInstall with poetry from Repo

pipx install canarycd-cli

• Install pipx

pipx install git+https://github.com/rehborn/canary-cli.git@main

poetry add git+https://github.com/rehborn/canary-cli.git@main

Enable Autocompletion

$ ccd --install-completion

Usage

See Usage Examples

ccd
├── cli 
│   ├── set [KEY] [VALUE]
│   └── unset [KEY]
│
├── config 
│   ├── set [KEY] [VALUE]
│   └── list
│
├── git-key 
│   ├── list
│   ├── view [KEY]
│   ├── create --type [ssh|pat] --key [KEY] --import [KEY_FILE]
│   └── delete [KEY]
│
├── project 
│   ├── list
│   ├── view [PROJECT]
│   ├── create [PROJECT] --remote [REMOTE] --key [KEY]
│   ├── update [PROJECT] --remote [REMOTE] --key [KEY]
│   ├── delete [PROJECT]
│   ├── refresh-token [PROJECT]
│   ├── status [PROJECT] [ENV]
│   └── deploy [PROJECT] [ENV]
│
├── env [PROJECT]
│   ├── list 
│   ├── view [ENV]
│   ├── create [ENV] --branch [BRANCH]
│   ├── update [ENV] --branch [BRANCH]
│   ├── delete [ENV]
│   ├── set [ENV] [KEY] [VALUE]
│   ├── unset [ENV] [KEY] 
│   ├── import [ENV] [FILE]
│
├── page
│   ├── list
│   ├── create [FQDN]
│   ├── delete [FQDN]
│   ├── refresh-token [FQDN]
│   └── deploy [FQDN] [FILE]
│
├── redirect
│   ├── list
│   ├── create [SOURCE] [DESTINATION]
│   ├── update [SOURCE] [DESTINATION]
│   └── delete [SOURCE]

Was this page helpful?