@convertkit/cloudkit
====================


* Usage
* Commands

Usage

``sh-session
$ npm install -g @convertkit/cloudkit
$ cloudkit COMMAND
running command...
$ cloudkit (-v|--version|version)
@convertkit/cloudkit/0.0.35 darwin-arm64 node-v23.7.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 canary:update
* [cloudkit console [ENVIRONMENT]](#cloudkit-console-environment)
* [cloudkit console:copy SOURCE DESTINATION [ENVIRONMENT]](#cloudkit-consolecopy-source-destination-environment)
* [cloudkit console:cp SOURCE DESTINATION [ENVIRONMENT]](#cloudkit-consolecp-source-destination-environment)
* [cloudkit console:persistent [ENVIRONMENT]](#cloudkit-consolepersistent-environment)
* [cloudkit console:session [ENVIRONMENT]](#cloudkit-consolesession-environment)
* cloudkit custom-domain:ssl-reissue
* cloudkit db:console
* cloudkit ghost
* cloudkit helm:rollback ENVIRONMENT
* [cloudkit help [COMMAND]](#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 canary:update

Update canary traffic percentage for a given workload.

`
USAGE
$ cloudkit canary:update

OPTIONS
-a, --app=app [default: ckapp] app
-p, --percentage=percentage [default: 10] percentage

DESCRIPTION
Update canary traffic percentage for a given workload.
`

_See code: src/commands/canary/update.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:copy SOURCE DESTINATION [ENVIRONMENT]

Copies files between local machine and Rails console pods.

`
USAGE
$ cloudkit console:copy SOURCE DESTINATION [ENVIRONMENT]

ARGUMENTS
SOURCE Source file path (local or console path)
DESTINATION Destination file path (local or console path)
ENVIRONMENT [default: staging] Environment (staging, production, etc.)

OPTIONS
-E, --email email-sending sidekiq shard
-a, --app=app [default: ckapp] app [ckapp, filekit, link-handling, geolocator, my-awesome-branch]
-e, --environment=environment [default: staging] environment
-p, --pod=pod Specify pod name directly (skips auto-discovery)
-v, --verbose Show debug output
--from-console Explicitly copy from console
--to-console Explicitly copy to console

DESCRIPTION
Copies files between local machine and Rails console pods.
Automatically detects copy direction based on source path, or use --to-console/--from-console flags.
Only shows console pods belonging to the current SSH user (filtered by CONSOLE_USER environment variable).

Examples:
# Copy local file to console (auto-detected)
$ cloudkit console:copy ./big-csv.csv big-csv.csv production

# Copy from console to local (auto-detected)
$ cloudkit console:copy /app/data/output.csv ./output.csv production

# Explicit direction with pod specification
$ cloudkit console:copy --to-console --pod rails-console-abc123 ./file.csv file.csv production

# Debug pod discovery and filtering
$ cloudkit console:copy ./file.csv file.csv production -v
`

_See code: src/commands/console/copy.js_

cloudkit console:cp SOURCE DESTINATION [ENVIRONMENT]

Alias for console:copy command.

`
USAGE
$ cloudkit console:cp SOURCE DESTINATION [ENVIRONMENT]

DESCRIPTION
Alias for console:copy command. See cloudkit console:copy for full documentation.
`

_See code: src/commands/console/cp.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
-d, --database=database [default: primary] database
-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_