@devopness/cli

Command Line Interface to Devopness.com - All DevOps you need

• Usage
• Commands

Usage

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

Commands

• devopness BaseCommand
• devopness apps:add
• devopness apps:list
• devopness cronjob:add
• devopness cronjob:list
• devopness environment:add
• devopness environment:list
• devopness help [COMMAND]
• devopness login
• devopness project:add
• devopness project:list
• devopness server:add
• devopness server:list
• devopness ssh

devopness BaseCommand

USAGE
  $ devopness BaseCommand

OPTIONS
  -h, --help  Show help for a given command in the form "devopness COMMAND --help"
  -y, --yes   Non-interactive mode bypassing confirmation dialogs

See code: src/commands/BaseCommand.ts

devopness apps:add

USAGE
  $ devopness apps:add

OPTIONS
  -a, --listening_address=listening_address        App's URL IP:PORT, HOSTNAME:PORT or unix:PATH
  -b, --branch=branch                              (required) Default branch to be deployed
  -e, --environment=environment                    Environment (name or id) that the cronojob will be linked to
  -f, --framework=framework                        The Framework your app was built on top of
  -h, --help                                       Show help for a given command in the form "devopness COMMAND --help"

  -l, --programming_language=programming_language  The predominant programming language used in the application source
                                                   code

  -n, --name=name                                  Name (valid domain name)

  -p, --project=project                            Project (name or id) to which the app will be added

  -r, --repository=repository                      The full name of a repository (`repository_owner/repository_name`)
                                                   containing the application source code

  -s, --server=server                              Server (name or id) to which the app should be added

  -t, --type=(web|non-web)                         (required) The application's type

  -w, --public_directory=public_directory          Public directory: the app directory that is publicly accessible

  -y, --yes                                        Non-interactive mode bypassing confirmation dialogs

  --build_command=build_command                    Build command

  --entrypoint=entrypoint                          App's main file, module or start up command

  --source_provider=source_provider                Source provider (name or id) where the app repository is hosted

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

devopness apps:list

USAGE
  $ devopness apps:list

OPTIONS
  -h, --help             Show help for a given command in the form "devopness COMMAND --help"
  -p, --project=project  Name or Id of the project to use
  -y, --yes              Non-interactive mode bypassing confirmation dialogs

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

devopness cronjob:add

USAGE
  $ devopness cronjob:add

OPTIONS
  -c, --command=command          Command to be executed
  -e, --environment=environment  Environment (name or id) that the cronjob will be linked to
  -f, --frequency=frequency      Frequency at which the job will be executed
  -h, --help                     Show help for a given command in the form "devopness COMMAND --help"
  -n, --name=name                Name your cronjob for easier reminder
  -p, --project=project          Project (name or id) to which the cronjob will be added
  -s, --servers=servers          A comma separated list of servers (name or id) that the cronojob will be linked to
  -u, --user=user                The system user on behalf of which the cron job will run
  -y, --yes                      Non-interactive mode bypassing confirmation dialogs

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

devopness cronjob:list

USAGE
  $ devopness cronjob:list

OPTIONS
  -h, --help             Show help for a given command in the form "devopness COMMAND --help"
  -p, --project=project  Name or Id of the project to use
  -y, --yes              Non-interactive mode bypassing confirmation dialogs

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

devopness environment:add

USAGE
  $ devopness environment:add

OPTIONS
  -h, --help                                 Show help for a given command in the form "devopness COMMAND --help"
  -n, --name=name                            (required) The name of the environment to be created
  -p, --project=project                      Name or Id of the project to use
  -t, --type=development|staging|production  The type of the environment to be created
  -y, --yes                                  Non-interactive mode bypassing confirmation dialogs

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

devopness environment:list

USAGE
  $ devopness environment:list

OPTIONS
  -h, --help             Show help for a given command in the form "devopness COMMAND --help"
  -p, --project=project  Name or Id of the project to use
  -y, --yes              Non-interactive mode bypassing confirmation dialogs

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

devopness help [COMMAND]

display help for devopness

USAGE
  $ devopness help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

devopness login

Login using your credentials for interacting with Devopness

USAGE
  $ devopness login

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  User pass word
  -u, --user=user          User e-mail address

See code: src/commands/login.ts

devopness project:add

USAGE
  $ devopness project:add

OPTIONS
  -h, --help       Show help for a given command in the form "devopness COMMAND --help"
  -n, --name=name  (required) The name of the project to be created
  -y, --yes        Non-interactive mode bypassing confirmation dialogs

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

devopness project:list

USAGE
  $ devopness project:list

OPTIONS
  -h, --help  Show help for a given command in the form "devopness COMMAND --help"
  -y, --yes   Non-interactive mode bypassing confirmation dialogs

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

devopness server:add

USAGE
  $ devopness server:add

OPTIONS
  -e, --environment=environment  Environment (name or id) that the server will be linked to
  -h, --help                     Show help for a given command in the form "devopness COMMAND --help"
  -i, --ip_address=ip_address    Server IP address
  -n, --name=name                Server name
  -p, --project=project          Project (name or id) that the server will be added to
  -y, --yes                      Non-interactive mode bypassing confirmation dialogs
  --ssh_port=ssh_port            Server SSH port (usually 22)

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

devopness server:list

USAGE
  $ devopness server:list

OPTIONS
  -h, --help             Show help for a given command in the form "devopness COMMAND --help"
  -p, --project=project  Name or Id of the project to use
  -y, --yes              Non-interactive mode bypassing confirmation dialogs

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

devopness ssh

SSH into one of your servers

USAGE
  $ devopness ssh

OPTIONS
  -h, --help                     Show help for a given command in the form "devopness COMMAND --help"
  -n, --server_name=server_name  Name of the server to connect to
  -p, --project=project          Name or Id of the project to use
  -s, --server_id=server_id      Id of the server to connect to
  -y, --yes                      Non-interactive mode bypassing confirmation dialogs

See code: src/commands/ssh.ts