Skip to content
Disco Documentation

CLI Reference

The disco command-line interface (CLI) provides various commands to interact with the Disco platform.

To install the CLI, see this page.

disco apikeys:list

Section titled “disco apikeys:list”

list all api keys

USAGE
  $ disco apikeys:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  list all api keys


EXAMPLES
  $ disco apikeys:list

See code: src/commands/apikeys/list.ts

disco apikeys:remove [PUBLICKEY]

Section titled “disco apikeys:remove [PUBLICKEY]”

remove an api key

USAGE
  $ disco apikeys:remove [PUBLICKEY] [--disco <value>]


ARGUMENTS
  PUBLICKEY  public api key


FLAGS
  --disco=<value>


DESCRIPTION
  remove an api key


EXAMPLES
  $ disco apikeys:remove API_KEY

See code: src/commands/apikeys/remove.ts

disco autocomplete [SHELL]

Section titled “disco autocomplete [SHELL]”

Display autocomplete installation instructions.

USAGE
  $ disco autocomplete [SHELL] [-r]


ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type


FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)


DESCRIPTION
  Display autocomplete installation instructions.


EXAMPLES
  $ disco autocomplete


  $ disco autocomplete bash


  $ disco autocomplete zsh


  $ disco autocomplete powershell


  $ disco autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

disco deploy

Section titled “disco deploy”

deploy a project, a specific commit or a disco.json file

USAGE
  $ disco deploy --project <value> [--commit <value>] [--file <value>] [--disco <value>]


FLAGS
  --commit=<value>
  --disco=<value>
  --file=<value>
  --project=<value>  (required)


DESCRIPTION
  deploy a project, a specific commit or a disco.json file


EXAMPLES
  $ disco deploy --project mysite


  $ disco deploy --project mysite --commit 7b5c8f935328c1af49c9037cac9dee7bf0bd8c7e

See code: src/commands/deploy.ts

disco deploy:cancel

Section titled “disco deploy:cancel”

cancel a deployment for a project. if a deployment number is not specified, the latest deployment will be cancelled

USAGE
  $ disco deploy:cancel --project <value> [--deployment <value>] [--disco <value>]


FLAGS
  --deployment=<value>
  --disco=<value>
  --project=<value>     (required)


DESCRIPTION
  cancel a deployment for a project. if a deployment number is not specified, the latest deployment will be cancelled


EXAMPLES
  $ disco deploy:cancel --project mysite


  $ disco deploy:cancel --project mysite --deployment 4

See code: src/commands/deploy/cancel.ts

disco deploy:list

Section titled “disco deploy:list”

list the deployments for a project

USAGE
  $ disco deploy:list --project <value> [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  list the deployments for a project


EXAMPLES
  $ disco deploy:list --project mysite

See code: src/commands/deploy/list.ts

disco deploy:output

Section titled “disco deploy:output”

see the output of the latest deployment, or a particular deployment

USAGE
  $ disco deploy:output --project <value> [--deployment <value>] [--disco <value>]


FLAGS
  --deployment=<value>
  --disco=<value>
  --project=<value>     (required)


DESCRIPTION
  see the output of the latest deployment, or a particular deployment


EXAMPLES
  $ disco deploy:output --project mysite


  $ disco deploy:output --project mysite --deployment 4

See code: src/commands/deploy/output.ts

disco discos:list

Section titled “disco discos:list”

list the discos

USAGE
  $ disco discos:list


DESCRIPTION
  list the discos


EXAMPLES
  $ disco discos:list

See code: src/commands/discos/list.ts

disco domains:add DOMAIN

Section titled “disco domains:add DOMAIN”

add a domain name to the project

USAGE
  $ disco domains:add DOMAIN --project <value> [--disco <value>]


ARGUMENTS
  DOMAIN  domain name


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  add a domain name to the project


EXAMPLES
  $ disco domains:add www.example.com --project mysite

See code: src/commands/domains/add.ts

disco domains:list

Section titled “disco domains:list”

list the domains

USAGE
  $ disco domains:list --project <value> [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  list the domains


EXAMPLES
  $ disco domains:list --project mysite

See code: src/commands/domains/list.ts

disco domains:remove DOMAIN

Section titled “disco domains:remove DOMAIN”

remove the domain

USAGE
  $ disco domains:remove DOMAIN --project <value> [--disco <value>]


ARGUMENTS
  DOMAIN  domain to remove


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  remove the domain


EXAMPLES
  $ disco domains:remove www.example.com --project mysite

See code: src/commands/domains/remove.ts

disco env:get [ENVVAR]

Section titled “disco env:get [ENVVAR]”

read one environment variable

USAGE
  $ disco env:get [ENVVAR] --project <value> [--disco <value>]


ARGUMENTS
  ENVVAR  environment variable to read


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  read one environment variable


EXAMPLES
  $ disco env:get --project mysite API_KEY

See code: src/commands/env/get.ts

disco env:list

Section titled “disco env:list”

list the env vars

USAGE
  $ disco env:list --project <value> [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  list the env vars


EXAMPLES
  $ disco env:list --project mysite

See code: src/commands/env/list.ts

disco env:remove [ENVVAR]

Section titled “disco env:remove [ENVVAR]”

remove the env var

USAGE
  $ disco env:remove [ENVVAR] --project <value> [--disco <value>]


ARGUMENTS
  ENVVAR  variable to remove


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  remove the env var


EXAMPLES
  $ disco env:remove --project mysite API_KEY

See code: src/commands/env/remove.ts

disco env:set [VARIABLES]

Section titled “disco env:set [VARIABLES]”

set env vars

USAGE
  $ disco env:set [VARIABLES...] --project <value> [--disco <value>]


ARGUMENTS
  VARIABLES...  variables to set


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  set env vars


EXAMPLES
  $ disco env:set API_KEY=0x97BCD3


  $ disco env:set API_KEY=0x97BCD3 OTHER_API_KEY=sk_f98a7f97as896

See code: src/commands/env/set.ts

disco github:apps:add

Section titled “disco github:apps:add”

add a Github app

USAGE
  $ disco github:apps:add [--organization <value>] [--disco <value>]


FLAGS
  --disco=<value>
  --organization=<value>


DESCRIPTION
  add a Github app


EXAMPLES
  $ disco github:apps:add

See code: src/commands/github/apps/add.ts

disco github:apps:list

Section titled “disco github:apps:list”

list Github apps

USAGE
  $ disco github:apps:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  list Github apps


EXAMPLES
  $ disco github:apps:list

See code: src/commands/github/apps/list.ts

disco github:apps:manage OWNER

Section titled “disco github:apps:manage OWNER”

manage Github app

USAGE
  $ disco github:apps:manage OWNER [--disco <value>]


ARGUMENTS
  OWNER  the user or org name from Github


FLAGS
  --disco=<value>


DESCRIPTION
  manage Github app


EXAMPLES
  $ disco github:apps:manage

See code: src/commands/github/apps/manage.ts

disco github:apps:prune

Section titled “disco github:apps:prune”

prune Github apps

USAGE
  $ disco github:apps:prune [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  prune Github apps


EXAMPLES
  $ disco github:apps:prune

See code: src/commands/github/apps/prune.ts

disco github:repos:list

Section titled “disco github:repos:list”

list Github repos accessible thoughs Github Apps

USAGE
  $ disco github:repos:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  list Github repos accessible thoughs Github Apps


EXAMPLES
  $ disco github:repos:list

See code: src/commands/github/repos/list.ts

disco help [COMMAND]

Section titled “disco help [COMMAND]”

Display help for disco.

USAGE
  $ disco help [COMMAND...] [-n]


ARGUMENTS
  COMMAND...  Command to show help for.


FLAGS
  -n, --nested-commands  Include all nested commands in the output.


DESCRIPTION
  Display help for disco.

See code: @oclif/plugin-help

disco init SSHSTRING

Section titled “disco init SSHSTRING”

initializes a new server

USAGE
  $ disco init SSHSTRING [--version <value>] [--verbose] [--host <value>] [--local-image <value>]
    [--advertise-addr <value>] [--cloudflare-tunnel <value>] [-i <value>]


FLAGS
  -i, --identity-file=<value>      SSH key to use for authentication
      --advertise-addr=<value>     fixed IP address used to add nodes. defaults to resolving domain name of ssh
                                   connection
      --cloudflare-tunnel=<value>  Cloudflare Tunnel token, if you want to run disco behind a Cloudflare tunnel
      --host=<value>               hostname to use, when installing using an internal IP for the SSH connection, e.g.
                                   disco init root@10.1.2.3 --host disco.example.com
      --local-image=<value>        local Docker image to upload and use (mostly for Disco development)
      --verbose                    show extra output
      --version=<value>            [default: latest] version of disco daemon to install


DESCRIPTION
  initializes a new server


EXAMPLES
  $ disco init root@disco.example.com


  $ disco init root@disco.example.com --version 0.4.0

See code: src/commands/init.ts

disco invite:accept URL

Section titled “disco invite:accept URL”

accept an invite to deploy to a server

USAGE
  $ disco invite:accept URL [--show-only]


ARGUMENTS
  URL  invite url


FLAGS
  --show-only  Show new API key only without updating CLI config


DESCRIPTION
  accept an invite to deploy to a server


EXAMPLES
  $ disco invite:accept https://mymachine.com/api-key-invites/8979ab987a9b879

See code: src/commands/invite/accept.ts

disco invite:create NAME

Section titled “disco invite:create NAME”

invite someone to deploy to this server. server must have a dedicated domain name, see the meta:host command

USAGE
  $ disco invite:create NAME [--disco <value>]


ARGUMENTS
  NAME  api key invitee name


FLAGS
  --disco=<value>


DESCRIPTION
  invite someone to deploy to this server. server must have a dedicated domain name, see the meta:host command


EXAMPLES
  $ disco invite:create --disco mymachine.com zoe

See code: src/commands/invite/create.ts

disco logs

Section titled “disco logs”

fetch logs

USAGE
  $ disco logs [--project <value>] [--service <value>] [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>
  --service=<value>


DESCRIPTION
  fetch logs


EXAMPLES
  $ disco logs

See code: src/commands/logs.ts

disco meta:host DOMAIN

Section titled “disco meta:host DOMAIN”

set a host for the server

USAGE
  $ disco meta:host DOMAIN [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  set a host for the server


EXAMPLES
  $ disco meta:host example.com

See code: src/commands/meta/host.ts

disco meta:info

Section titled “disco meta:info”

fetch info about the server

USAGE
  $ disco meta:info [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  fetch info about the server


EXAMPLES
  $ disco meta:info

See code: src/commands/meta/info.ts

disco meta:stats

Section titled “disco meta:stats”

fetch stats about the server

USAGE
  $ disco meta:stats [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  fetch stats about the server


EXAMPLES
  $ disco meta:stats

See code: src/commands/meta/stats.ts

disco meta:upgrade

Section titled “disco meta:upgrade”

upgrade server

USAGE
  $ disco meta:upgrade [--image <value>] [--dont-pull] [--disco <value>]


FLAGS
  --disco=<value>
  --dont-pull      don't pull the image before upgrading
  --image=<value>  the image to use. Defaults to letsdiscodev/daemon:latest


DESCRIPTION
  upgrade server


EXAMPLES
  $ disco meta:upgrade

See code: src/commands/meta/upgrade.ts

disco nodes:add SSHSTRING

Section titled “disco nodes:add SSHSTRING”

initializes a new server

USAGE
  $ disco nodes:add SSHSTRING [--verbose] [-i <value>] [--disco <value>]


FLAGS
  -i, --identity-file=<value>  SSH key to use for authentication
  --disco=<value>
      --verbose                show extra output


DESCRIPTION
  initializes a new server


EXAMPLES
  $ disco nodes:add root@disco.example.com


  $ disco nodes:add root@disco.example.com --version 0.4.0

See code: src/commands/nodes/add.ts

disco nodes:list

Section titled “disco nodes:list”

show node list

USAGE
  $ disco nodes:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  show node list


EXAMPLES
  $ disco nodes:list

See code: src/commands/nodes/list.ts

disco nodes:remove NAME

Section titled “disco nodes:remove NAME”

remove node

USAGE
  $ disco nodes:remove NAME [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  remove node


EXAMPLES
  $ disco nodes:remove brilliant-fleet

See code: src/commands/nodes/remove.ts

disco plugins

Section titled “disco plugins”

List installed plugins.

USAGE
  $ disco plugins [--json] [--core]


FLAGS
  --core  Show core plugins.


GLOBAL FLAGS
  --json  Format output as json.


DESCRIPTION
  List installed plugins.


EXAMPLES
  $ disco plugins

See code: @oclif/plugin-plugins

disco plugins:add PLUGIN

Section titled “disco plugins:add PLUGIN”

Installs a plugin into disco.

USAGE
  $ disco plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]


ARGUMENTS
  PLUGIN...  Plugin to install.


FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.


GLOBAL FLAGS
  --json  Format output as json.


DESCRIPTION
  Installs a plugin into disco.


  Uses npm to install plugins.


  Installation of a user-installed plugin will override a core plugin.


  Use the DISCO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DISCO_NPM_REGISTRY environment variable to set the npm registry.


ALIASES
  $ disco plugins:add


EXAMPLES
  Install a plugin from npm registry.


    $ disco plugins:add myplugin


  Install a plugin from a github url.


    $ disco plugins:add https://github.com/someuser/someplugin


  Install a plugin from a github slug.


    $ disco plugins:add someuser/someplugin

disco plugins:inspect PLUGIN...

Section titled “disco plugins:inspect PLUGIN...”

Displays installation properties of a plugin.

USAGE
  $ disco plugins:inspect PLUGIN...


ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.


FLAGS
  -h, --help     Show CLI help.
  -v, --verbose


GLOBAL FLAGS
  --json  Format output as json.


DESCRIPTION
  Displays installation properties of a plugin.


EXAMPLES
  $ disco plugins:inspect myplugin

See code: @oclif/plugin-plugins

disco plugins:install PLUGIN

Section titled “disco plugins:install PLUGIN”

Installs a plugin into disco.

USAGE
  $ disco plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]


ARGUMENTS
  PLUGIN...  Plugin to install.


FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.


GLOBAL FLAGS
  --json  Format output as json.


DESCRIPTION
  Installs a plugin into disco.


  Uses npm to install plugins.


  Installation of a user-installed plugin will override a core plugin.


  Use the DISCO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DISCO_NPM_REGISTRY environment variable to set the npm registry.


ALIASES
  $ disco plugins:add


EXAMPLES
  Install a plugin from npm registry.


    $ disco plugins:install myplugin


  Install a plugin from a github url.


    $ disco plugins:install https://github.com/someuser/someplugin


  Install a plugin from a github slug.


    $ disco plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

Section titled “disco plugins:link PATH”

Links a plugin into the CLI for development.

USAGE
  $ disco plugins:link PATH [-h] [--install] [-v]


ARGUMENTS
  PATH  [default: .] path to plugin


FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.


DESCRIPTION
  Links a plugin into the CLI for development.


  Installation of a linked plugin will override a user-installed or core plugin.


  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.




EXAMPLES
  $ disco plugins:link myplugin

See code: @oclif/plugin-plugins

disco plugins:remove [PLUGIN]

Section titled “disco plugins:remove [PLUGIN]”

Removes a plugin from the CLI.

USAGE
  $ disco plugins:remove [PLUGIN...] [-h] [-v]


ARGUMENTS
  PLUGIN...  plugin to uninstall


FLAGS
  -h, --help     Show CLI help.
  -v, --verbose


DESCRIPTION
  Removes a plugin from the CLI.


ALIASES
  $ disco plugins:unlink
  $ disco plugins:remove


EXAMPLES
  $ disco plugins:remove myplugin

disco plugins:reset

Section titled “disco plugins:reset”

Remove all user-installed and linked plugins.

USAGE
  $ disco plugins:reset [--hard] [--reinstall]


FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

disco plugins:uninstall [PLUGIN]

Section titled “disco plugins:uninstall [PLUGIN]”

Removes a plugin from the CLI.

USAGE
  $ disco plugins:uninstall [PLUGIN...] [-h] [-v]


ARGUMENTS
  PLUGIN...  plugin to uninstall


FLAGS
  -h, --help     Show CLI help.
  -v, --verbose


DESCRIPTION
  Removes a plugin from the CLI.


ALIASES
  $ disco plugins:unlink
  $ disco plugins:remove


EXAMPLES
  $ disco plugins:uninstall myplugin

See code: @oclif/plugin-plugins

Section titled “disco plugins:unlink [PLUGIN]”

Removes a plugin from the CLI.

USAGE
  $ disco plugins:unlink [PLUGIN...] [-h] [-v]


ARGUMENTS
  PLUGIN...  plugin to uninstall


FLAGS
  -h, --help     Show CLI help.
  -v, --verbose


DESCRIPTION
  Removes a plugin from the CLI.


ALIASES
  $ disco plugins:unlink
  $ disco plugins:remove


EXAMPLES
  $ disco plugins:unlink myplugin

disco plugins:update

Section titled “disco plugins:update”

Update installed plugins.

USAGE
  $ disco plugins:update [-h] [-v]


FLAGS
  -h, --help     Show CLI help.
  -v, --verbose


DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

disco postgres:addon:install

Section titled “disco postgres:addon:install”

install Postgres addon

USAGE
  $ disco postgres:addon:install [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  install Postgres addon


EXAMPLES
  $ disco postgres:addon:install

See code: src/commands/postgres/addon/install.ts

disco postgres:addon:remove

Section titled “disco postgres:addon:remove”

remove Postgres addon

USAGE
  $ disco postgres:addon:remove [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  remove Postgres addon


EXAMPLES
  $ disco postgres:addon:remove

See code: src/commands/postgres/addon/remove.ts

disco postgres:addon:update

Section titled “disco postgres:addon:update”

update Postgres addon

USAGE
  $ disco postgres:addon:update [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  update Postgres addon


EXAMPLES
  $ disco postgres:addon:update

See code: src/commands/postgres/addon/update.ts

disco postgres:create

Section titled “disco postgres:create”

create a database for a project, ensuring addon and instance are installed

USAGE
  $ disco postgres:create --project <value> --env-var <value> [--disco <value>]


FLAGS
  --disco=<value>
  --env-var=<value>  (required) [default: DATABASE_URL]
  --project=<value>  (required)


DESCRIPTION
  create a database for a project, ensuring addon and instance are installed


EXAMPLES
  $ disco postgres:create

See code: src/commands/postgres/create.ts

disco postgres:databases:add

Section titled “disco postgres:databases:add”

add a Postgres database

USAGE
  $ disco postgres:databases:add --instance <value> [--disco <value>]


FLAGS
  --disco=<value>
  --instance=<value>  (required)


DESCRIPTION
  add a Postgres database


EXAMPLES
  $ disco postgres:databases:add

See code: src/commands/postgres/databases/add.ts

disco postgres:databases:attach

Section titled “disco postgres:databases:attach”

attach a Postgres database to a project

USAGE
  $ disco postgres:databases:attach --instance <value> --database <value> --env-var <value> --project <value> [--disco
  <value>]


FLAGS
  --database=<value>  (required)
  --disco=<value>
  --env-var=<value>   (required) [default: DATABASE_URL]
  --instance=<value>  (required)
  --project=<value>   (required)


DESCRIPTION
  attach a Postgres database to a project


EXAMPLES
  $ disco postgres:databases:attach

See code: src/commands/postgres/databases/attach.ts

disco postgres:databases:detach

Section titled “disco postgres:databases:detach”

detach a Postgres database from a project

USAGE
  $ disco postgres:databases:detach --instance <value> --database <value> --project <value> [--disco <value>] [--env-var
    <value>]


FLAGS
  --database=<value>  (required)
  --disco=<value>
  --env-var=<value>
  --instance=<value>  (required)
  --project=<value>   (required)


DESCRIPTION
  detach a Postgres database from a project


EXAMPLES
  $ disco postgres:databases:detach

See code: src/commands/postgres/databases/detach.ts

disco postgres:databases:list

Section titled “disco postgres:databases:list”

list Postgres databases

USAGE
  $ disco postgres:databases:list --instance <value> [--disco <value>]


FLAGS
  --disco=<value>
  --instance=<value>  (required)


DESCRIPTION
  list Postgres databases


EXAMPLES
  $ disco postgres:databases:list

See code: src/commands/postgres/databases/list.ts

disco postgres:databases:remove

Section titled “disco postgres:databases:remove”

remove a Postgres database

USAGE
  $ disco postgres:databases:remove --instance <value> --database <value> [--disco <value>] [--detach]


FLAGS
  --database=<value>  (required)
  --detach            detach from any project the database was attached to
  --disco=<value>
  --instance=<value>  (required)


DESCRIPTION
  remove a Postgres database


EXAMPLES
  $ disco postgres:databases:remove

See code: src/commands/postgres/databases/remove.ts

disco postgres:instances:add

Section titled “disco postgres:instances:add”

add a Postgres instance

USAGE
  $ disco postgres:instances:add [--image <value>] [--version <value>] [--disco <value>]


FLAGS
  --disco=<value>
  --image=<value>    the Docker image to use, without the tag
  --version=<value>  the tag to use for the Docker image


DESCRIPTION
  add a Postgres instance


EXAMPLES
  $ disco postgres:instances:add


  $ disco postgres:instances:add --image postgres --version 16.3


  $ disco postgres:instances:add --image postgis/postgis --version 17-3.5

See code: src/commands/postgres/instances/add.ts

disco postgres:instances:list

Section titled “disco postgres:instances:list”

list Postgres instances

USAGE
  $ disco postgres:instances:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  list Postgres instances


EXAMPLES
  $ disco postgres:instances:list

See code: src/commands/postgres/instances/list.ts

disco postgres:instances:remove

Section titled “disco postgres:instances:remove”

remove a Postgres instance

USAGE
  $ disco postgres:instances:remove --instance <value> [--disco <value>]


FLAGS
  --disco=<value>
  --instance=<value>  (required)


DESCRIPTION
  remove a Postgres instance


EXAMPLES
  $ disco postgres:instances:remove

See code: src/commands/postgres/instances/remove.ts

disco postgres:tunnel

Section titled “disco postgres:tunnel”

create a temporary tunnel to access Postgres through localhost

USAGE
  $ disco postgres:tunnel --project <value> [--disco <value>] [--env-var <value>] [--port <value>] [--super-user]


FLAGS
  --disco=<value>
  --env-var=<value>
  --port=<value>
  --project=<value>  (required)
  --super-user       connect as super user instead of database owner


DESCRIPTION
  create a temporary tunnel to access Postgres through localhost


EXAMPLES
  $ disco postgres:tunnel

See code: src/commands/postgres/tunnel.ts

disco projects:add [VARIABLES]

Section titled “disco projects:add [VARIABLES]”

add a project to an existing disco instance

USAGE
  $ disco projects:add [VARIABLES...] --name <value> --github <value> [--domain <value>] [--branch <value>]
    [--deployPublicRepo] [--disco <value>]


ARGUMENTS
  VARIABLES...  environment variables to set


FLAGS
  --branch=<value>    the branch of the repository to use
  --deployPublicRepo  deploy a public repository without checking for GitHub access. Note that "git push" to the repo
                      will not trigger a new deployment
  --disco=<value>     server to use
  --domain=<value>    domain name where the app will be served, e.g. www.example.com
  --github=<value>    (required) full name of the Github repository, including user or organization and repository name,
                      e.g. myuser/myproject
  --name=<value>      (required) project name


DESCRIPTION
  add a project to an existing disco instance


  this will deploy the project. from that point on, every "git push" to the project's repo will automatically trigger a
  new deployment.


  for most projects, you will need to pass a name, a domain name and a github repo. you can optionally pass environment
  variables as well.


EXAMPLES
  $ disco projects:add --name myblog --domain blog.example.com --github myuser/myblog


  $ disco projects:add --name myblog --domain blog.example.com --github myuser/myblog API_KEY=09asf07gaq0 OTHER_ENV_VAR=true

See code: src/commands/projects/add.ts

disco projects:list

Section titled “disco projects:list”

list projects

USAGE
  $ disco projects:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  list projects


EXAMPLES
  $ disco projects:list

See code: src/commands/projects/list.ts

disco projects:move

Section titled “disco projects:move”

move a project from one server to another

USAGE
  $ disco projects:move --project <value> --from-disco <value> --to-disco <value>


FLAGS
  --from-disco=<value>  (required) source disco server
  --project=<value>     (required) project name
  --to-disco=<value>    (required) destination disco server


DESCRIPTION
  move a project from one server to another


EXAMPLES
  $ disco projects:move --project mysite --from-disco 10.1.1.1 --to-disco 10.2.2.2

See code: src/commands/projects/move.ts

disco projects:remove PROJECT

Section titled “disco projects:remove PROJECT”

remove a project

USAGE
  $ disco projects:remove PROJECT [--no-input] [--disco <value>]


ARGUMENTS
  PROJECT  project to remove


FLAGS
  --disco=<value>
  --no-input       do not ask for confirmation


DESCRIPTION
  remove a project


EXAMPLES
  $ disco projects:remove project-name

See code: src/commands/projects/remove.ts

disco registry:addon:install

Section titled “disco registry:addon:install”

install Registry addon

USAGE
  $ disco registry:addon:install --domain <value> [--disco <value>]


FLAGS
  --disco=<value>
  --domain=<value>  (required) domain name where the registry will be served, e.g. registry.example.com


DESCRIPTION
  install Registry addon


EXAMPLES
  $ disco registry:addon:install

See code: src/commands/registry/addon/install.ts

disco registry:addon:remove

Section titled “disco registry:addon:remove”

remove Registry addon

USAGE
  $ disco registry:addon:remove [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  remove Registry addon


EXAMPLES
  $ disco registry:addon:remove

See code: src/commands/registry/addon/remove.ts

disco registry:addon:update

Section titled “disco registry:addon:update”

update Registry addon

USAGE
  $ disco registry:addon:update [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  update Registry addon


EXAMPLES
  $ disco registry:addon:update

See code: src/commands/registry/addon/update.ts

disco run [COMMAND]

Section titled “disco run [COMMAND]”

remotely run a command

USAGE
  $ disco run [COMMAND] --project <value> [--service <value>] [--timeout <value>] [--disco <value>]


ARGUMENTS
  COMMAND  command to run


FLAGS
  --disco=<value>
  --project=<value>  (required)
  --service=<value>
  --timeout=<value>  [default: 600]


DESCRIPTION
  remotely run a command


EXAMPLES
  $ disco run --project mysite "python migrate.py"

See code: src/commands/run.ts

disco scale:get

Section titled “disco scale:get”

get current scale (number of replicas) for all services of a project

USAGE
  $ disco scale:get --project <value> [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  get current scale (number of replicas) for all services of a project


EXAMPLES
  $ disco scale:get --project mysite

See code: src/commands/scale/get.ts

disco scale:set SERVICES

Section titled “disco scale:set SERVICES”

scale one or multiple services from a project

USAGE
  $ disco scale:set SERVICES... --project <value> [--disco <value>]


ARGUMENTS
  SERVICES...  service or services to scale and number of replicas, e.g. web=3


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  scale one or multiple services from a project


EXAMPLES
  $ disco scale:set --project mysite web=1


  $ disco scale:set --project mysite web=3 worker=2

See code: src/commands/scale/set.ts

disco syslog:add [SYSLOGDESTINATION]

Section titled “disco syslog:add [SYSLOGDESTINATION]”

add a log destination

USAGE
  $ disco syslog:add [SYSLOGDESTINATION] [--disco <value>]


ARGUMENTS
  SYSLOGDESTINATION  syslog destination, should be syslog:// or syslog+tls:// protocol


FLAGS
  --disco=<value>


DESCRIPTION
  add a log destination


EXAMPLES
  $ disco syslog:add syslog://logs.example.com:4415


  $ disco syslog:add syslog+tls://logs.example.com:4415

See code: src/commands/syslog/add.ts

disco syslog:list

Section titled “disco syslog:list”

see list of all log destinations

USAGE
  $ disco syslog:list [--disco <value>]


FLAGS
  --disco=<value>


DESCRIPTION
  see list of all log destinations


EXAMPLES
  $ disco syslog:list

See code: src/commands/syslog/list.ts

disco syslog:remove [SYSLOGDESTINATION]

Section titled “disco syslog:remove [SYSLOGDESTINATION]”

remove a log destination

USAGE
  $ disco syslog:remove [SYSLOGDESTINATION] [--disco <value>]


ARGUMENTS
  SYSLOGDESTINATION  syslog destination, should be syslog:// or syslog+tls:// protocol


FLAGS
  --disco=<value>


DESCRIPTION
  remove a log destination


EXAMPLES
  $ disco syslog:remove syslog://logs.example.com:4415


  $ disco syslog:remove syslog+tls://logs.example.com:4415

See code: src/commands/syslog/remove.ts

disco update [CHANNEL]

Section titled “disco update [CHANNEL]”

update the disco CLI

USAGE
  $ disco update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]


FLAGS
  -a, --available        See available versions.
  -b, --verbose          Show more details about the available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.


DESCRIPTION
  update the disco CLI


EXAMPLES
  Update to the stable channel:


    $ disco update stable


  Update to a specific version:


    $ disco update --version 1.0.0


  Interactively select version:


    $ disco update --interactive


  See available versions:


    $ disco update --available

See code: @oclif/plugin-update

disco volumes:export

Section titled “disco volumes:export”

export a volume

USAGE
  $ disco volumes:export --project <value> --volume <value> [--disco <value>] [--force] [--output <value>]


FLAGS
  --disco=<value>    disco configuration to use
  --force            force output to terminal without confirmation
  --output=<value>   output file path (instead of stdout)
  --project=<value>  (required) project ID
  --volume=<value>   (required) volume ID to export


DESCRIPTION
  export a volume


EXAMPLES
  $ disco volumes:export --project=myproject --volume=myvolume


  $ disco volumes:export --project=myproject --volume=myvolume > volume.tar.gz


  $ disco volumes:export --project=myproject --volume=myvolume --force

See code: src/commands/volumes/export.ts

disco volumes:import

Section titled “disco volumes:import”

import a volume

USAGE
  $ disco volumes:import --project <value> --volume <value> [--disco <value>] [--input <value>]


FLAGS
  --disco=<value>    disco configuration to use
  --input=<value>    input file path (instead of stdin)
  --project=<value>  (required) project ID
  --volume=<value>   (required) volume ID to export


DESCRIPTION
  import a volume


EXAMPLES
  $ disco volumes:import --project=myproject --volume=myvolume --input volume.tar.gz


  $ disco volumes:import --project=myproject --volume=myvolume < volume.tar.gz

See code: src/commands/volumes/import.ts

disco volumes:list

Section titled “disco volumes:list”

list all project’s volumes

USAGE
  $ disco volumes:list --project <value> [--disco <value>]


FLAGS
  --disco=<value>
  --project=<value>  (required)


DESCRIPTION
  list all project's volumes


EXAMPLES
  $ disco volumes:list --project mysite

See code: src/commands/volumes/list.ts