@convertkit/cloudkit

• Usage
• Commands

Usage

$ npm install -g @convertkit/cloudkit
$ cloudkit COMMAND
running command...
$ cloudkit (-v|--version|version)
@convertkit/cloudkit/0.0.31 darwin-arm64 node-v22.1.0
$ cloudkit --help [COMMAND]
USAGE
  $ cloudkit COMMAND
...

Note: if you run into ssh errors, you'll need to add extra config to your ~/.ssh/config. Here is an example for staging:

Host production-deploy
  HostName 172.21.3.91
  IdentityFile ~/.ssh/id_rsa
  ForwardAgent yes
  AddKeysToAgent yes
  IdentitiesOnly yes
  StrictHostKeyChecking no
  User your_username

Host production-deploy-restricted
  HostName 172.21.4.56
  IdentityFile ~/.ssh/id_rsa
  AddKeysToAgent yes
  ForwardAgent yes
  IdentitiesOnly yes
  StrictHostKeyChecking no
  User your_username
  ServerAliveInterval 240

Host staging-deploy
 HostName 10.11.6.74
 IdentityFile ~/.ssh/id_rsa
 AddKeysToAgent yes
 ForwardAgent yes
 IdentitiesOnly yes
 StrictHostKeyChecking no
 User your_username
 ServerAliveInterval 240

Commands

• cloudkit canary:cleanup
• cloudkit console [ENVIRONMENT]
• cloudkit console:persistent [ENVIRONMENT]
• cloudkit console:session [ENVIRONMENT]
• cloudkit custom-domain:ssl-reissue
• cloudkit db:console
• cloudkit ghost
• cloudkit helm:rollback ENVIRONMENT
• cloudkit help [COMMAND]
• cloudkit migrate VERSION
• cloudkit migrate:down VERSION
• cloudkit migrate:status
• cloudkit puma:restart
• cloudkit rake
• cloudkit release
• cloudkit run
• cloudkit schema:dump
• cloudkit shell
• cloudkit sidekiq:pause
• cloudkit sidekiq:restart
• cloudkit sidekiq:unpause
• cloudkit vault:delete ENVIRONMENT
• cloudkit vault:get ENVIRONMENT
• cloudkit vault:list ENVIRONMENT
• cloudkit vault:put ENVIRONMENT
• cloudkit vault:rollback ENVIRONMENT

cloudkit canary:cleanup

Cleanup canary deployment from K8S

USAGE
  $ cloudkit canary:cleanup

OPTIONS
  -a, --app=app  [default: ckapp] app

DESCRIPTION
  Cleanup canary deployment from K8S

See code: src/commands/canary/cleanup.js

cloudkit console [ENVIRONMENT]

Starts a remote Rails console.

USAGE
  $ cloudkit console [ENVIRONMENT]

OPTIONS
  -E, --email    email-sending sidekiq shard
  -a, --app=app  [default: ckapp] app [ckapp, filekit, link-handling, geolocator, my-awesome-branch]
  -l, --large    Deploys a rails console with 4GB of memory.

DESCRIPTION
  Starts a remote Rails console.

See code: src/commands/console/index.js

cloudkit console:persistent [ENVIRONMENT]

Starts a persistent Rails console.

USAGE
  $ cloudkit console:persistent [ENVIRONMENT]

OPTIONS
  -E, --email    email-sending sidekiq shard
  -a, --app=app  [default: ckapp] app [ckapp, filekit, link-handling, geolocator]

DESCRIPTION
  Starts a persistent Rails console.

See code: src/commands/console/persistent.js

cloudkit console:session [ENVIRONMENT]

Manage persistent rails console sessions

USAGE
  $ cloudkit console:session [ENVIRONMENT]

OPTIONS
  -a, --attach=attach  Attach to a specific rails console session
  -l, --ls             List the current active sessions

DESCRIPTION
  Manage persistent rails console sessions

See code: src/commands/console/session.js

cloudkit custom-domain:ssl-reissue

Reissues the SSL certificate for a given custom domain.

USAGE
  $ cloudkit custom-domain:ssl-reissue

OPTIONS
  -d, --domain=domain            (required) domain
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Reissues the SSL certificate for a given custom domain.

See code: src/commands/custom-domain/ssl-reissue.js

cloudkit db:console

Get a DB console session

USAGE
  $ cloudkit db:console

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Get a DB console session

See code: src/commands/db/console.js

cloudkit ghost

Runs a gh-ost migration from a rails console

USAGE
  $ cloudkit ghost

OPTIONS
  --execute              A boolean value determining whether or not to execute the gh-ost migration
  --migration=migration  (required) The gh-ost migration file with or without the .ghost extension

DESCRIPTION
  Runs a gh-ost migration from a rails console

See code: src/commands/ghost/index.js

cloudkit helm:rollback ENVIRONMENT

Rollback helm releases for a given app.

USAGE
  $ cloudkit helm:rollback ENVIRONMENT

OPTIONS
  -a, --app=app  (required) app [ckapp, link-handling, filekit, creator-pass etc.]

DESCRIPTION
  Rollback helm releases for a given app.

See code: src/commands/helm/rollback.js

cloudkit help [COMMAND]

display help for cloudkit

USAGE
  $ cloudkit help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cloudkit migrate VERSION

Runs db:migrate on a remote machine.

USAGE
  $ cloudkit migrate VERSION

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Runs db:migrate on a remote machine.

See code: src/commands/migrate/index.js

cloudkit migrate:down VERSION

Runs db:migrate:down on a remote machine.

USAGE
  $ cloudkit migrate:down VERSION

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Runs db:migrate:down on a remote machine.

See code: src/commands/migrate/down.js

cloudkit migrate:status

Runs db:migrate:status on a remote machine.

USAGE
  $ cloudkit migrate:status

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Runs db:migrate:status on a remote machine.

See code: src/commands/migrate/status.js

cloudkit puma:restart

Restarts puma.

USAGE
  $ cloudkit puma:restart

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Restarts puma.

See code: src/commands/puma/restart.js

cloudkit rake

Executes a script in a remote rails session.

USAGE
  $ cloudkit rake

OPTIONS
  -A, --args=args                args
  -E, --email                    email-sending sidekiq shard
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Executes a script in a remote rails session.

See code: src/commands/rake/index.js

cloudkit release

Get the current release for any app

USAGE
  $ cloudkit release

OPTIONS
  -a, --app=app                  [default: ckapp] App name [ckapp-web, ckapp-sidekiq, link-handling, filekit,
                                 creator-pass, etc.]

  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Get the current release for any app

See code: src/commands/release/index.js

cloudkit run

Executes a script in a remote rails session.

USAGE
  $ cloudkit run

OPTIONS
  -E, --email                    email-sending sidekiq shard
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment
  -f, --file=file                file

DESCRIPTION
  Executes a script in a remote rails session.

See code: src/commands/run/index.js

cloudkit schema:dump

Runs db:schema:dump on a remote machine.

USAGE
  $ cloudkit schema:dump

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Runs db:schema:dump on a remote machine.

See code: src/commands/schema/dump.js

cloudkit shell

SSH into a remote machine.

USAGE
  $ cloudkit shell

OPTIONS
  -E, --email                    email-sending sidekiq shard
  -a, --app=app                  [default: ckapp] app [ckapp, filekit, link-handling, my-awesome-branch]
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  SSH into a remote machine.

See code: src/commands/shell/index.js

cloudkit sidekiq:pause

Pause a sidekiq queue for a given workload.

USAGE
  $ cloudkit sidekiq:pause

OPTIONS
  -E, --email                    email-sending sidekiq shard
  -a, --app=app                  [default: ckapp] app [ckapp, filekit, link-handling, geolocator]
  -e, --environment=environment  [default: staging] environment
  -q, --queue=queue              (required) Queue name or use the string 'all' to pause every single queue.

DESCRIPTION
  Pause a sidekiq queue for a given workload.

See code: src/commands/sidekiq/pause.js

cloudkit sidekiq:restart

Restarts sidekiq.

USAGE
  $ cloudkit sidekiq:restart

OPTIONS
  -a, --app=app                  [default: ckapp] app
  -e, --environment=environment  [default: staging] environment

DESCRIPTION
  Restarts sidekiq.

See code: src/commands/sidekiq/restart.js

cloudkit sidekiq:unpause

Unpause a sidekiq queue for a given workload.

USAGE
  $ cloudkit sidekiq:unpause

OPTIONS
  -E, --email                    email-sending sidekiq shard
  -a, --app=app                  [default: ckapp] app [ckapp, filekit, link-handling, geolocator]
  -e, --environment=environment  [default: staging] environment
  -q, --queue=queue              (required) Queue name or use the string 'all' to unpause every single queue.

DESCRIPTION
  Unpause a sidekiq queue for a given workload.

See code: src/commands/sidekiq/unpause.js

cloudkit vault:delete ENVIRONMENT

Get the value from a Vault Key.

USAGE
  $ cloudkit vault:delete ENVIRONMENT

OPTIONS
  -a, --app=app  [default: ckapp] app
  -k, --key=key  key

DESCRIPTION
  Get the value from a Vault Key.

See code: src/commands/vault/delete.js

cloudkit vault:get ENVIRONMENT

Get the value from a Vault Key.

USAGE
  $ cloudkit vault:get ENVIRONMENT

OPTIONS
  -a, --app=app  [default: ckapp] app
  -k, --key=key  key

DESCRIPTION
  Get the value from a Vault Key.

See code: src/commands/vault/get.js

cloudkit vault:list ENVIRONMENT

List key names from Vault.

USAGE
  $ cloudkit vault:list ENVIRONMENT

OPTIONS
  -a, --app=app  [default: ckapp] app

DESCRIPTION
  List key names from Vault.

See code: src/commands/vault/list.js

cloudkit vault:put ENVIRONMENT

Set a new secret on Vault.

USAGE
  $ cloudkit vault:put ENVIRONMENT

OPTIONS
  -a, --app=app      [default: ckapp] app
  -k, --key=key      key
  -v, --value=value  Base64 encoded string with the value

DESCRIPTION
  Set a new secret on Vault.

See code: src/commands/vault/put.js

cloudkit vault:rollback ENVIRONMENT

Get the value from a Vault Key.

USAGE
  $ cloudkit vault:rollback ENVIRONMENT

OPTIONS
  -a, --app=app  [default: ckapp] app
  -k, --key=key  key

DESCRIPTION
  Get the value from a Vault Key.

See code: src/commands/vault/rollback.js