@divio/cli v0.7.2

@divio/cli

Divio Cloud CLI

• Usage
• Other install method
• Commands
• Tests

Usage

$ npm install -g @divio/cli
$ divio COMMAND
running command...
$ divio (-v|--version|version)
@divio/cli/0.7.2 linux-x64 node-v12.16.1
$ divio --help [COMMAND]
USAGE
  $ divio COMMAND
...

Other install method

curl -L https://divio.com/cli/install.sh | sh

Commands

• divio autocomplete [SHELL]
• divio config
• divio doctor
• divio flavour
• divio flavour:add [ADDONS]
• divio flavour:check [ADDONS]
• divio flavour:remove [ADDONS]
• divio help [COMMAND]
• divio login
• divio logout
• divio project
• divio project:dashboard
• divio project:deploy [ENVIRONMENT]
• divio project:deploy-log [ENVIRONMENT]
• divio project:env-vars
• divio project:export
• divio project:import [DUMP-PATH]
• divio project:list
• divio project:open [ENVIRONMENT]
• divio project:pull TYPE
• divio project:push TYPE
• divio project:setup SLUG
• divio project:status
• divio project:stop
• divio project:up
• divio project:update
• divio update [CHANNEL]

divio autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ divio autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ divio autocomplete
  $ divio autocomplete bash
  $ divio autocomplete zsh
  $ divio autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

divio config

Show divio cli configuration

USAGE
  $ divio config

OPTIONS
  -h, --help  show CLI help
  --edit      Open config in editor
  --path      Show path to config file

EXAMPLES
  divio config
  divio config --path
  # edit with vim
  $ EDITOR="vim" divio config --edit
  # edit with atom editor
  $ VISUAL="atom --wait" divio config --edit

See code: src/commands/config.ts

divio doctor

Check if your system meets the requirements for local development of Divio Cloud projects

USAGE
  $ divio doctor

OPTIONS
  -c, --check=login|git|docker-client|docker-machine|docker-compose|docker-server|docker-server-ping|docker-server-dns
      Specific services to check

  -h, --help
      show CLI help

  -m, --machine-readable
      Outputs JSON

See code: src/commands/doctor.ts

divio flavour

Install / Uninstall flavours

USAGE
  $ divio flavour

See code: src/commands/flavour/index.ts

divio flavour:add [ADDONS]

Add addon

USAGE
  $ divio flavour:add [ADDONS]

ARGUMENTS
  ADDONS  The flavour identifier(s) of the addon, e.g.: divio/django

OPTIONS
  -h, --help                   show CLI help
  --addonmanager=addonmanager  Optionally specify addon manager, bypassing the registry
  --[no-]cache                 Should use flavour addon managers that is available locally or check for latest
  --[no-]check                 Check if the addon is valid
  --package=package            File path or the url to package yaml
  --registry=registry          [default: https://hub.eu.aldryn.io]
  --verbose                    Verbose output

EXAMPLE
  $ flavour add addon1 addon2

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

divio flavour:check [ADDONS]

Check addon

USAGE
  $ divio flavour:check [ADDONS]

ARGUMENTS
  ADDONS  The flavour identifier(s) of the addon, e.g.: divio/django

OPTIONS
  -h, --help                   show CLI help
  --addonmanager=addonmanager  Optionally specify addon manager, bypassing the registry
  --[no-]cache                 Should use flavour addon managers that is available locally or check for latest
  --package=package            File path or the url to package yaml
  --registry=registry          [default: https://hub.eu.aldryn.io]
  --verbose                    Verbose output

EXAMPLE
  $ flavour check addon1 addon2

See code: src/commands/flavour/check.ts

divio flavour:remove [ADDONS]

Remove addon

USAGE
  $ divio flavour:remove [ADDONS]

ARGUMENTS
  ADDONS  The flavour identifier(s) of the addon, e.g.: divio/django

OPTIONS
  -h, --help                   show CLI help
  --addonmanager=addonmanager  Optionally specify addon manager, bypassing the registry
  --[no-]cache                 Should use flavour addon managers that is available locally or check for latest
  --[no-]check                 Check if the addon is valid
  --package=package            File path or the url to package yaml
  --registry=registry          [default: https://hub.eu.aldryn.io]
  --verbose                    Verbose output

EXAMPLE
  $ flavour remove addon1 addon2

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

divio help [COMMAND]

display help for divio

USAGE
  $ divio help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

divio login

Authorize your machine with the Divio Cloud

USAGE
  $ divio login

OPTIONS
  -h, --help  show CLI help
  --check     Check for current login status

EXAMPLES
  $ divio login
  $ echo $DIVIO_TOKEN | divio login

See code: src/commands/login.ts

divio logout

Logs you out

USAGE
  $ divio logout

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ divio logout

See code: src/commands/logout.ts

divio project

Project commands

USAGE
  $ divio project

See code: src/commands/project/index.ts

divio project:dashboard

Open project dashboard

USAGE
  $ divio project:dashboard

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/dashboard.ts

divio project:deploy [ENVIRONMENT]

Deploy or see current deployment progress

USAGE
  $ divio project:deploy [ENVIRONMENT]

OPTIONS
  -h, --help             show CLI help

  --remote-id=remote-id  Remote project ID to use for project commands. Defaults to the project in the current directory
                         using the .divio/active file.

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

divio project:deploy-log [ENVIRONMENT]

View last deployment log

USAGE
  $ divio project:deploy-log [ENVIRONMENT]

OPTIONS
  -h, --help             show CLI help

  --remote-id=remote-id  Remote project ID to use for project commands. Defaults to the project in the current directory
                         using the .divio/active file.

See code: src/commands/project/deploy-log.ts

divio project:env-vars

Get or set environment variables (experimental)

USAGE
  $ divio project:env-vars

OPTIONS
  -h, --help             show CLI help
  -s, --stage=test|live  [default: test] Get data from environment (e.g. "test" or "live")
  --all                  Show all env vars, not just the custom ones
  --edit                 Edit environment variables
  --get=get              Get specific environment variables
  --json                 Show as json

  --remote-id=remote-id  Remote project ID to use for project commands. Defaults to the project in the current directory
                         using the .divio/active file.

EXAMPLES
  divio project:env-vars
  divio project:env-vars --all
  divio project:env-vars --get VAR
  divio project:env-vars --get VAR*
  # edit with vim
  $ EDITOR="vim" divio project:env-vars --edit
  # edit with atom editor
  $ VISUAL="atom --wait" divio project:env-vars --edit

See code: src/commands/project/env-vars.ts

divio project:export

Export db from the local project

USAGE
  $ divio project:export

OPTIONS
  -h, --help  show CLI help

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

divio project:import [DUMP-PATH]

Import db to the local project

USAGE
  $ divio project:import [DUMP-PATH]

OPTIONS
  -h, --help  show CLI help

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

divio project:list

List projects

USAGE
  $ divio project:list

OPTIONS
  -h, --help         show CLI help
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --csv              output is csv format
  --grouped          group by organisation
  --json             output as json
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen

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

divio project:open [ENVIRONMENT]

Open project in the browser

USAGE
  $ divio project:open [ENVIRONMENT]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/open.ts

divio project:pull TYPE

Pull db or files from the Divio Cloud

USAGE
  $ divio project:pull TYPE

ARGUMENTS
  TYPE  (db|media)

OPTIONS
  -h, --help             show CLI help
  -s, --stage=test|live  [default: test] Pull data from environment (e.g. "test" or "live")

  --remote-id=remote-id  Remote project ID to use for project commands. Defaults to the project in the current directory
                         using the .divio/active file.

See code: src/commands/project/pull.ts

divio project:push TYPE

Push db or files to the Divio Cloud

USAGE
  $ divio project:push TYPE

ARGUMENTS
  TYPE  (db|media)

OPTIONS
  -d, --dumpfile=dumpfile
  -h, --help               show CLI help
  -s, --stage=test|live    [default: test] Push data to environment (e.g. "test" or "live")
  --noinput                Don't ask for confirmation

  --remote-id=remote-id    Remote project ID to use for project commands. Defaults to the project in the current
                           directory using the .divio/active file.

See code: src/commands/project/push.ts

divio project:setup SLUG

Setup project locally

USAGE
  $ divio project:setup SLUG

OPTIONS
  -h, --help         show CLI help
  -p, --path=path    [default: .] Path to install the project
  -s, --stage=stage  [default: test] Pull data from environment (e.g. "test" or "live")
  --overwrite        Overwrite the project directory if it already exists
  --skip-doctor      Skip system test before setting up the project

See code: src/commands/project/setup.ts

divio project:status

Show local project status

USAGE
  $ divio project:status

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/status.ts

divio project:stop

Stop project

USAGE
  $ divio project:stop

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/stop.ts

divio project:up

Start project

USAGE
  $ divio project:up

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/up.ts

divio project:update

Update project

USAGE
  $ divio project:update

OPTIONS
  -h, --help  show CLI help
  --strict    A strict update will fail on a warning

See code: src/commands/project/update.ts

divio update [CHANNEL]

update the divio CLI

USAGE
  $ divio update [CHANNEL]

See code: @oclif/plugin-update

Tests

To run:

npm run test