Canary CLI Usage Guide

CLI Configuration

Set API Key Set API URL

ccd cli set API_KEY secret-key

ccd cli set API_URL http://localhost:8001

List Set Unset

ccd config list

ccd config set KEY VALUE

ccd config unset KEY

List Keys SSH Key Import SSH Key Github PAT Github App Delete Key

ccd auth list

$ ccd auth create foo-key --ssh > repo-key.pub

Optional: Import SSH Git-Key to Github as Deploy-Key

$ gh repo deploy-key add repo-key.pub

$ ccd auth create --import private-key-file.key

$ ccd auth create my-key --pat ghp_foobar

!!! bug "not imeplemented

ccd auth delete my-key

Assign Authentication Key to a Project

$ ccd project update my-project --key my-key

List Projects View Details Delete Refresh Token

ccd list

ccd view foo/bar@main

ccd delete foo@main

ccd refresh-token foo@main

Github Custom Remote, Branch and Key

ccd create foo/bar@dev

$ ccd project create my-project \
    --remote git@github.com:user/repo \
    --branch main \
    --key my-repo-key

shortcut github repositories

$ ccd project create --remote foo/bar@main

use the current directory's name git remote as params

$ ccd project create . --remote . --key repo-ssh-key

Update Key Update Remote Update Branch

ccd update foo@main --key ssh-key

ccd update foo@main --remote foo/bar

ccd update foo@main --branch dev

ccd deploy foo-bar --start

Deploy CLI Deploy Webhook

$ ccd project deploy foo/bar@main --start

$ ccd project refresh-token foo/bar@main

Trigger with curl

$ curl $HOST/deploy/project/rpO58I7odyQGsL0pz..

TODO: Github Webhook Setup

Get Status

$ ccd project deploy foobar --status

set optional secrets for a project, these are for use the compose.yml and inside the container environment.

List Secrets Set Secret Delete Secret Import Secrets from file Copy Secrets

$ ccd secret foo/bar@main

$ ccd secret foo/bar@main FOO bar

$ ccd secret foo/bar@main FOO --delete

$ ccd secret foo/bar@main --import .env

$ ccd secret foo/bar@main --copy F* --destination foo/bar@production

not implemented

List Create Create Params Delete Upload Refresh Token

ccd page list

ccd page create example.com

ccd page create example.com \
    --redirect www.example.com \
    --cors example2.com \

ccd page delete example.com

ccd page example.com deploy payload.tar

Create a Payload Archive

tar cf payload.tar -C public/ .

ccd page refresh-token example.com

List Create Update Delete

ccd redirect list

ccd redirect create www.example.com example.com

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

ccd redirect delete www.example.com

Was this page helpful?