Canary CLI Usage Guide

CLI Configuration

# Set API Key
$ ccd config set API_KEY test
API_KEY=test

# Set API URL
$ ccd config set API_URL http://localhost:8001
API_URL=http://localhost:8001

Server Configuration

ccd config list

ccd config set KEY VALUE

ccd config unset KEY 

Git-Key

Create SSH-Key

ccd git-key create --type ssh

Import SSH-Key

ccd git-key create keyname --type ssh --import ssh-key.pub

Create Github PAT

ccd git-key create keyname --type pat --key 'ghp..'

Delete Key

ccd git-key delete keyname

Project

Create

ccd project create foo --remote git://git@github.com/foo/repo

Update

ccd project update foo --key ssh-key

Delete

ccd project delete foo

Refresh Token

ccd project refresh-token foo 

Deploy

ccd project deploy foo default

Environment

this isn't very intuitive yet

alternative usage under consideration:

• ccd project env foo create default --branch main
• ccd env create default --project foo --branch main

create

ccd env foo create default --branch main

delete

ccd env foo delete default

import

ccd env foo import default .env

set

ccd env foo set default VARIABLE variable-value

unset

ccd env foo unset default VARIABLE

Pages

List

ccd page list

Create

ccd page create example.com

Delete

ccd page delete example.com

Upload

tar cf payload.tar -C public/ .
ccd page example.com deploy payload.tar

Refresh Token

ccd page refresh-token example.com

Redirect

Create

ccd redirect www.example.com example.com --create

Update

ccd redirect update www.example.com foo.example.com

Delete

ccd redirect delete www.example.com

Was this page helpful?