GuidesAPI reference
DiscordDashboard
DiscordDashboard

pipeline environments

Manage environments on remote compute service

Usage

usage: pipeline environments [-h] {create,get,list,ls,delete,rm,update} ...

Options

--help, -h: Get help information on command

Commands

  • create: Create a new environment
  • get: Get information on an environment
  • list, ls: List environments
  • delete, rm: Delete an environment
  • update: Update an existing environment

pipeline environments create

Create a new environment

Usage

usage: pipeline environments create [-h] [-r REQUIREMENTS] [-l] name

Options

  • -h, --help
  • -r, --requirements: Create an environment from a requirements file requirements.txt
  • -l, --from-local: Create a new environment using the local environment packages

Arguments

  • name: The name of the new environment

pipeline environments get

Get information on an environment

Usage

usage: pipeline environments get [-h] [--default] [-n] name_or_id

Options

  • -h, --help: Show the help message and exit
  • --default: Get the default environment
  • -n: Get the environment by name

Arguments

  • name_or_id: The name or ID of the environment

pipeline environments list

List environments

Usage

usage: pipeline environments list [-h] [-l LIMIT] [-s SKIP]

Options

  • -h, --help
  • -l, --limit: Number of environments to show
  • -s, --skip: Number of initial environments to skip (pagination)
  • --public: List publicly available environments

pipeline environments delete

Delete an environment

Usage

usage: pipeline environments delete [-h] [-n] name_or_id

Options

  • -h, --help
  • -n:Delete the environment by name

Arguments

  • name_or_id: The name or ID of the environment to delete

pipeline environments update

Update an existing environment

Usage

usage: pipeline environments update [-h] [-n] name_or_id {lock,unlock,add,remove} ..

Options

  • -h, --help
  • -n: Update the environment by name

Arguments

  • name_or_id: The name of ID of the environment to update

Commands

  • lock: The environment to lock, this stops the environment from being deleted or edited
  • unlock: The environment to unlock
  • add: Add a new package to the environment
  • remove: Remove a package from the environment