sidepro

The SidePro CLI

• Usage
• Commands

Usage

$ npm install -g sidepro
$ sidepro COMMAND
running command...
$ sidepro (--version)
sidepro/1.8.4 linux-x64 node-v20.18.0
$ sidepro --help [COMMAND]
USAGE
  $ sidepro COMMAND
...

Commands

• sidepro app
• sidepro app chart
• sidepro app chart list
• sidepro app chart show CHART_NAME
• sidepro app create APP_NAME
• sidepro app delete [APP_NAMES]
• sidepro app deployment
• sidepro app deployment list APP_NAME
• sidepro app deployment rollback APPLICATION ID
• sidepro app env
• sidepro app env list APP_NAME
• sidepro app env set APP_NAME [KEY] [VALUE]
• sidepro app env unset APP_NAME KEY
• sidepro app exec APP_NAME
• sidepro app github
• sidepro app github create
• sidepro app github delete
• sidepro app github list
• sidepro app list
• sidepro app logs APP_NAME
• sidepro app manifest APP_NAME [MANIFEST_FILE]
• sidepro app open APP_NAME
• sidepro app restage APP_NAME
• sidepro app restart APP_NAME
• sidepro app scale APP_NAME INSTANCES
• sidepro app show APP_NAME
• sidepro app update APP_NAME
• sidepro apps
• sidepro autocomplete [SHELL]
• sidepro charts
• sidepro deployments APP_NAME
• sidepro envs APP_NAME
• sidepro help [COMMAND]
• sidepro login
• sidepro logout
• sidepro namespace
• sidepro namespace create NAMESPACE_NAME
• sidepro namespace delete NAMESPACE_NAME
• sidepro namespace list
• sidepro namespace show NAMESPACE_NAME
• sidepro namespace update NAMESPACE_NAME
• sidepro namespaces
• sidepro pull
• sidepro pull disable APP_NAME
• sidepro pull enable APP_NAME [GIT_REPO] [BRANCH_NAME]
• sidepro push [MANIFEST]
• sidepro rollback APPLICATION ID
• sidepro service
• sidepro service bind SERVICE_NAME APP_NAME
• sidepro service catalog [SERVICE_NAME]
• sidepro service create CATALOG_NAME SERVICE_NAME
• sidepro service delete [SERVICE_NAME]
• sidepro service list
• sidepro service open SERVICE_NAME
• sidepro service port-forward SERVICE_NAME LOCAL_PORT
• sidepro service show SERVICE_NAME
• sidepro service unbind SERVICE_NAME APP_NAME
• sidepro service update SERVICE_NAME
• sidepro services
• sidepro update [CHANNEL]

sidepro app

Manage applications in SidePro Cloud.

USAGE
  $ sidepro app

DESCRIPTION
  Manage applications in SidePro Cloud.

EXAMPLES
  $ sidepro app list

  $ sidepro app show my-app

  $ sidepro app exec my-app

  $ sidepro app logs my-app

  $ sidepro app manifest my-app

  $ sidepro app port-forward my-app 8080:8080

  $ sidepro app restage my-app

  $ sidepro app restart my-app

  $ sidepro app update my-app

  $ sidepro app create my-app

  $ sidepro app delete my-app

  $ sidepro app env set my-app KEY VALUE

  $ sidepro app env unset my-app KEY

  $ sidepro app env list my-app

  $ sidepro app scale my-app 3

  $ sidepro app chart list

  $ sidepro app chart show standard

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

sidepro app chart

Manage the configuration options of the specified application chart.

USAGE
  $ sidepro app chart [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Manage the configuration options of the specified application chart.

EXAMPLES
  $ sidepro app chart list

  $ sidepro app chart show standard

See code: src/commands/app/chart/index.ts

sidepro app chart list

List application charts along with their available configuration options.

USAGE
  $ sidepro app chart list

DESCRIPTION
  List application charts along with their available configuration options.

ALIASES
  $ sidepro charts

See code: src/commands/app/chart/list.ts

sidepro app chart show CHART_NAME

Show the details of the specified application chart.

USAGE
  $ sidepro app chart show CHART_NAME

ARGUMENTS
  CHART_NAME  Name of the chart

DESCRIPTION
  Show the details of the specified application chart.

See code: src/commands/app/chart/show.ts

sidepro app create APP_NAME

Create a new application, but don't build it. Most of the time you should use "push" instead.

USAGE
  $ sidepro app create APP_NAME [-e <value>...] [-i <value>] [-r <value>... | -z] [--app-chart standard|x-beta |
    --beta-chart] [--chart-value <value>...] [--port <value>] [--cpu 100m|500m|1|2|4] [--memory
    128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi]

ARGUMENTS
  APP_NAME  Name of the application

FLAGS
  -e, --env=<value>...          Environment variables to set
  -i, --instances=<value>       Number of instances
  -r, --route=<value>...        Custom route to use for the application
  -z, --clear-routes            Clear existing routes
      --app-chart=<option>      App chart to use for deployment
                                <options: standard|x-beta>
      --beta-chart              Use the beta chart for deployment. Defaults to false
      --chart-value=<value>...  Values to set for the app chart
      --cpu=<option>            CPU limit for the application. If set, the platform will limit the CPU usage of the
                                application to this value. If not set, the platform will use the default CPU limit of
                                100m. Allowed values are 100m, 500m, 1, 2, and 4
                                <options: 100m|500m|1|2|4>
      --memory=<option>         Memory limit for the application. If set, the platform will limit the memory usage of
                                the application to this value. If not set, the platform will use the default memory
                                limit of 128Mi. Allowed values are 128Mi, 256Mi, 512Mi, 1Gi, 2Gi, 4Gi, 6Gi, and 8Gi
                                <options: 128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi>
      --port=<value>            Port that the application listens on. If set, the platform will forward traffic to this
                                port. If not set, the platform will use the default port of 8080

DESCRIPTION
  Create a new application, but don't build it. Most of the time you should use "push" instead.

EXAMPLES
  $ sidepro app create myapp --instances 3 --env KEY=VALUE

  $ sidepro app create myapp --app-chart standard --route custom.domain.com

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

sidepro app delete [APP_NAMES]

Delete one or more applications.

USAGE
  $ sidepro app delete [APP_NAMES...] [-a] [-f]

ARGUMENTS
  APP_NAMES...  Names of the applications to delete

FLAGS
  -a, --all    Delete all applications
  -f, --force  Force delete

DESCRIPTION
  Delete one or more applications.

See code: src/commands/app/delete.ts

sidepro app deployment

Manage application deployments.

USAGE
  $ sidepro app deployment [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Manage application deployments.

EXAMPLES
  $ sidepro app deployment list my-app

  $ sidepro app deployment rollback my-app ID

See code: src/commands/app/deployment/index.ts

sidepro app deployment list APP_NAME

List application deployments

USAGE
  $ sidepro app deployment list APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  List application deployments

ALIASES
  $ sidepro deployments

See code: src/commands/app/deployment/list.ts

sidepro app deployment rollback APPLICATION ID

Rollback a specific release of an application.

USAGE
  $ sidepro app deployment rollback APPLICATION ID

ARGUMENTS
  APPLICATION  Name of the application
  ID           ID of the release to rollback

DESCRIPTION
  Rollback a specific release of an application.

ALIASES
  $ sidepro rollback

See code: src/commands/app/deployment/rollback.ts

sidepro app env

Modifies env vars for the specified application.

USAGE
  $ sidepro app env [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Modifies env vars for the specified application.

EXAMPLES
  $ sidepro app env set my-app KEY VALUE

  $ sidepro app env set my-app --from-file env.txt

  $ sidepro app env unset my-app KEY

  $ sidepro app env list my-app

See code: src/commands/app/env/index.ts

sidepro app env list APP_NAME

List environment variables for the specified application.

USAGE
  $ sidepro app env list APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  List environment variables for the specified application.

ALIASES
  $ sidepro envs

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

sidepro app env set APP_NAME [KEY] [VALUE]

Set environment variables for the specified application.

USAGE
  $ sidepro app env set APP_NAME [KEY] [VALUE] [-f <value>]

ARGUMENTS
  APP_NAME  Name of the application
  KEY       Key to create or update an Env var
  VALUE     Value pair to create or update an Env var

FLAGS
  -f, --from-file=<value>  Read the value from a file

DESCRIPTION
  Set environment variables for the specified application.

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

sidepro app env unset APP_NAME KEY

Unset environment variables for the specified application.

USAGE
  $ sidepro app env unset APP_NAME KEY

ARGUMENTS
  APP_NAME  Name of the application
  KEY       Key to create or update an Env var

DESCRIPTION
  Unset environment variables for the specified application.

See code: src/commands/app/env/unset.ts

sidepro app exec APP_NAME

Execute a shell for the application.

USAGE
  $ sidepro app exec APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  Execute a shell for the application.

See code: src/commands/app/exec.ts

sidepro app github

Manage github credentials configuration

USAGE
  $ sidepro app github

DESCRIPTION
  Manage github credentials configuration

EXAMPLES
  $ sidepro app github create

  $ sidepro app github delete

  $ sidepro app github list

See code: src/commands/app/github/index.ts

sidepro app github create

USAGE
  $ sidepro app github create

See code: src/commands/app/github/create.ts

sidepro app github delete

USAGE
  $ sidepro app github delete

See code: src/commands/app/github/delete.ts

sidepro app github list

USAGE
  $ sidepro app github list

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

sidepro app list

List all applications.

USAGE
  $ sidepro app list [-a]

FLAGS
  -a, --all  List all applications in all namespaces

DESCRIPTION
  List all applications.

ALIASES
  $ sidepro apps

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

sidepro app logs APP_NAME

Show logs of the specified application.

USAGE
  $ sidepro app logs APP_NAME [-f | -c] [-b | ] [-d]

ARGUMENTS
  APP_NAME  Name of the application

FLAGS
  -b, --build      Show the build logs of the application
  -c, --clipboard  Copy the logs to your clipboard
  -d, --detail     Show more detail in the logs
  -f, --follow     Follow the logs of the application

DESCRIPTION
  Show logs of the specified application.

See code: src/commands/app/logs.ts

sidepro app manifest APP_NAME [MANIFEST_FILE]

Save the manifest of the specified application to a file.

USAGE
  $ sidepro app manifest APP_NAME [MANIFEST_FILE]

ARGUMENTS
  APP_NAME       Name of the application
  MANIFEST_FILE  [default: sidepro.yml] Path to save the manifest file

DESCRIPTION
  Save the manifest of the specified application to a file.

See code: src/commands/app/manifest.ts

sidepro app open APP_NAME

Opens the specified application in the browser.

USAGE
  $ sidepro app open APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  Opens the specified application in the browser.

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

sidepro app restage APP_NAME

Restage the specified application.

USAGE
  $ sidepro app restage APP_NAME [--no-restart] [-d]

ARGUMENTS
  APP_NAME  Name of the application

FLAGS
  -d, --detail      Show more detail in the logs
      --no-restart  Do not restart application after restaging

DESCRIPTION
  Restage the specified application.

See code: src/commands/app/restage.ts

sidepro app restart APP_NAME

Restart the specified application.

USAGE
  $ sidepro app restart APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  Restart the specified application.

See code: src/commands/app/restart.ts

sidepro app scale APP_NAME INSTANCES

Modifies the amount of replicas for the specified application.

USAGE
  $ sidepro app scale APP_NAME INSTANCES

ARGUMENTS
  APP_NAME   Name of the application
  INSTANCES  Amount of running instances of your application

DESCRIPTION
  Modifies the amount of replicas for the specified application.

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

sidepro app show APP_NAME

Show the details of the specified application.

USAGE
  $ sidepro app show APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  Show the details of the specified application.

See code: src/commands/app/show.ts

sidepro app update APP_NAME

Update an existing application.

USAGE
  $ sidepro app update APP_NAME [-e <value>...] [-i <value>] [-r <value>... | -z] [--app-chart standard|x-beta |
    --beta-chart] [--chart-value <value>...] [--port <value>] [--cpu 100m|500m|1|2|4] [--memory
    128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi]

ARGUMENTS
  APP_NAME  Name of the application

FLAGS
  -e, --env=<value>...          Environment variables to set
  -i, --instances=<value>       Number of instances
  -r, --route=<value>...        Custom route to use for the application
  -z, --clear-routes            Clear existing routes
      --app-chart=<option>      App chart to use for deployment
                                <options: standard|x-beta>
      --beta-chart              Use the beta chart for deployment. Defaults to false
      --chart-value=<value>...  Values to set for the app chart
      --cpu=<option>            CPU limit for the application. If set, the platform will limit the CPU usage of the
                                application to this value. If not set, the platform will use the default CPU limit of
                                100m. Allowed values are 100m, 500m, 1, 2, and 4
                                <options: 100m|500m|1|2|4>
      --memory=<option>         Memory limit for the application. If set, the platform will limit the memory usage of
                                the application to this value. If not set, the platform will use the default memory
                                limit of 128Mi. Allowed values are 128Mi, 256Mi, 512Mi, 1Gi, 2Gi, 4Gi, 6Gi, and 8Gi
                                <options: 128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi>
      --port=<value>            Port that the application listens on. If set, the platform will forward traffic to this
                                port. If not set, the platform will use the default port of 8080

DESCRIPTION
  Update an existing application.

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

sidepro apps

List all applications.

USAGE
  $ sidepro apps [-a]

FLAGS
  -a, --all  List all applications in all namespaces

DESCRIPTION
  List all applications.

ALIASES
  $ sidepro apps

sidepro autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ sidepro 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
  $ sidepro autocomplete

  $ sidepro autocomplete bash

  $ sidepro autocomplete zsh

  $ sidepro autocomplete powershell

  $ sidepro autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

sidepro charts

List application charts along with their available configuration options.

USAGE
  $ sidepro charts

DESCRIPTION
  List application charts along with their available configuration options.

ALIASES
  $ sidepro charts

sidepro deployments APP_NAME

List application deployments

USAGE
  $ sidepro deployments APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  List application deployments

ALIASES
  $ sidepro deployments

sidepro envs APP_NAME

List environment variables for the specified application.

USAGE
  $ sidepro envs APP_NAME

ARGUMENTS
  APP_NAME  Name of the application

DESCRIPTION
  List environment variables for the specified application.

ALIASES
  $ sidepro envs

sidepro help [COMMAND]

Display help for sidepro.

USAGE
  $ sidepro 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 sidepro.

See code: @oclif/plugin-help

sidepro login

Login to the SidePro Cloud using OIDC.

USAGE
  $ sidepro login -a <value> [-t] [-p]

FLAGS
  -a, --address=<value>  (required) [default: https://epinio.platform.beta.sidepro.app] Address of the SidePro Cloud
                         instance
  -p, --prompt           Prompt for the authorization code instead of using a local server
  -t, --trustCA          Trust the CA certificate without prompting

DESCRIPTION
  Login to the SidePro Cloud using OIDC.

See code: src/commands/login.ts

sidepro logout

Logout from the SidePro Cloud.

USAGE
  $ sidepro logout

DESCRIPTION
  Logout from the SidePro Cloud.

See code: src/commands/logout.ts

sidepro namespace

Manage namespaces

USAGE
  $ sidepro namespace

DESCRIPTION
  Manage namespaces

EXAMPLES
  $ sidepro namespace list

  $ sidepro namespace update my-namespace

  $ sidepro namespace show my-namespace

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

sidepro namespace create NAMESPACE_NAME

Create a new namespace.

USAGE
  $ sidepro namespace create NAMESPACE_NAME

ARGUMENTS
  NAMESPACE_NAME  Name of the namespace

DESCRIPTION
  Create a new namespace.

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

sidepro namespace delete NAMESPACE_NAME

Delete a namespace.

USAGE
  $ sidepro namespace delete NAMESPACE_NAME

ARGUMENTS
  NAMESPACE_NAME  Name of the namespace

DESCRIPTION
  Delete a namespace.

See code: src/commands/namespace/delete.ts

sidepro namespace list

List all namespaces.

USAGE
  $ sidepro namespace list

DESCRIPTION
  List all namespaces.

ALIASES
  $ sidepro namespaces

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

sidepro namespace show NAMESPACE_NAME

Show the details of the specified namespace.

USAGE
  $ sidepro namespace show NAMESPACE_NAME

ARGUMENTS
  NAMESPACE_NAME  Name of the namespace

DESCRIPTION
  Show the details of the specified namespace.

See code: src/commands/namespace/show.ts

sidepro namespace update NAMESPACE_NAME

Sets the namespace for SidePro

USAGE
  $ sidepro namespace update NAMESPACE_NAME

ARGUMENTS
  NAMESPACE_NAME  Name of the namespace

DESCRIPTION
  Sets the namespace for SidePro

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

sidepro namespaces

List all namespaces.

USAGE
  $ sidepro namespaces

DESCRIPTION
  List all namespaces.

ALIASES
  $ sidepro namespaces

sidepro pull

Manage auto-pull on your apps

USAGE
  $ sidepro pull

DESCRIPTION
  Manage auto-pull on your apps

EXAMPLES
  $ sidepro pull enable my-app

  $ sidepro pull disable my-app

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

sidepro pull disable APP_NAME

Disable auto-pull for your application.

USAGE
  $ sidepro pull disable APP_NAME [-f]

ARGUMENTS
  APP_NAME  Name of the application to disable auto-pull

FLAGS
  -f, --force  Force disable without confirmation

DESCRIPTION
  Disable auto-pull for your application.

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

sidepro pull enable APP_NAME [GIT_REPO] [BRANCH_NAME]

Enable auto-pull for your application.

USAGE
  $ sidepro pull enable APP_NAME [GIT_REPO] [BRANCH_NAME] [-w <value>]

ARGUMENTS
  APP_NAME     Name of the application to enable auto-pull
  GIT_REPO     Git repository for the application.
  BRANCH_NAME  Git branch to monitor for auto-pull.

FLAGS
  -w, --slack-webhook=<value>  Slack webhook URL to get notifications from auto-pull

DESCRIPTION
  Enable auto-pull for your application.

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

sidepro push [MANIFEST]

Push an application to the SidePro Cloud. If a manifest file is provided, the application will be created based on the manifest file. Otherwise, the application will be created based on the provided flags.

USAGE
  $ sidepro push [MANIFEST] [-n <value>] [-p <value> | -g <value> | --container-image-url <value>]
    [--git-provider git|github|github_enterprise|gitlab|gitlab_enterprise ] [--chart-value <value>...] [--cron-schedule
    <value> | [--app-chart standard|x-beta | --beta-chart] | -r <value>... | -z | -i <value> | --static-site <value>]
    [--builder-image heroku-22|paketo-full|paketo-base] [-e <value>...] [--build-scripts <value>] [--port <value>]
    [--cpu 100m|500m|1|2|4] [--memory 128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi]

ARGUMENTS
  MANIFEST  [default: sidepro.yml] Path to the application manifest file. If the manifest file is not found, the
            application will be created based on the provided flags

FLAGS
  -e, --env=<value>...               Environment variables to set for the build process and runtime environment. Should
                                     be in the format of key=value. Can be specified multiple times to provide multiple
                                     environment variables
  -g, --git=<value>                  Git repository and revision of sources separated by comma (e.g. GIT_URL,REVISION).
                                     If this is set, the application will be created based on the sources in the Git
                                     repository
  -i, --instances=<value>            Number of instances to provision
  -n, --name=<value>                 Name of the application to register in the SidePro Cloud
  -p, --path=<value>                 Path to the application directory. Defaults to the current directory. If source is
                                     in a Git repo, use --git instead
  -r, --route=<value>...             Custom route to use for the application (a subdomain of the default domain will be
                                     used if this is not set). Can be set multiple times to use multiple routes with the
                                     same application
  -z, --clear-routes                 Clear existing routes
      --app-chart=<option>           App chart to use for deployment. Defaults to "standard"
                                     <options: standard|x-beta>
      --beta-chart                   Use the beta chart for deployment. Defaults to false
      --build-scripts=<value>        Applicable for Node.js and only used in conjunction with --static-site. Comma
                                     separated list of build steps specified in a package.json file. If this is set, the
                                     application will be created based on the build scripts
      --builder-image=<option>       Builder image to use for the application. Can be `heroku-22`, `paketo-full`, or
                                     `paketo-base`. Defaults to `heroku-22`
                                     <options: heroku-22|paketo-full|paketo-base>
      --chart-value=<value>...       Values to set for the app chart. Should be in the format of key=value. Can be
                                     specified multiple times to provide multiple values
      --container-image-url=<value>  URL of the container image to use for the application. If this is set, the
                                     application will be created based on the provided container image
      --cpu=<option>                 CPU limit for the application. If set, the platform will limit the CPU usage of the
                                     application to this value. If not set, the platform will use the default CPU limit
                                     of 100m. Allowed values are 100m, 500m, 1, 2, and 4
                                     <options: 100m|500m|1|2|4>
      --cron-schedule=<value>        Cron Schedule to pass for your app. Use it if your app is going to be a scheduled
                                     app with no webserver
      --git-provider=<option>        Name of the Git provider. Defaults to "git"
                                     <options: git|github|github_enterprise|gitlab|gitlab_enterprise>
      --memory=<option>              Memory limit for the application. If set, the platform will limit the memory usage
                                     of the application to this value. If not set, the platform will use the default
                                     memory limit of 128Mi. Allowed values are 128Mi, 256Mi, 512Mi, 1Gi, 2Gi, 4Gi, 6Gi,
                                     and 8Gi
                                     <options: 128Mi|256Mi|512Mi|1Gi|2Gi|4Gi|6Gi|8Gi>
      --port=<value>                 Port that the application listens on. If set, the platform will forward traffic to
                                     this port. If not set, the platform will use the default port of 8080
      --static-site=<value>          Path to the static site directory. If this is set, the application will be created
                                     as a static site. Overrides the builder-image and sets some environment variables

DESCRIPTION
  Push an application to the SidePro Cloud. If a manifest file is provided, the application will be created based on the
  manifest file. Otherwise, the application will be created based on the provided flags.

EXAMPLES
  $ sidepro push

  $ sidepro push -p <path-to-folder-or-archive>

  $ sidepro push -g <git-url-or-path>,<revision>

  $ sidepro push -c <container-image-url>

  $ sidepro push -n <app-name> -i <instances> -e <key=value> -r <route>

See code: src/commands/push.ts

sidepro rollback APPLICATION ID

Rollback a specific release of an application.

USAGE
  $ sidepro rollback APPLICATION ID

ARGUMENTS
  APPLICATION  Name of the application
  ID           ID of the release to rollback

DESCRIPTION
  Rollback a specific release of an application.

ALIASES
  $ sidepro rollback

sidepro service

Service management for the SidePro Cloud.

USAGE
  $ sidepro service

DESCRIPTION
  Service management for the SidePro Cloud.

EXAMPLES
  $ sidepro service catalog

  $ sidepro service list

  $ sidepro service show my-service

  $ sidepro service bind my-service my-app

  $ sidepro service unbind my-service my-app

  $ sidepro service create catalog-item my-service

  $ sidepro service delete my-service

  $ sidepro service open my-service

  $ sidepro service update my-service --set key=value

  $ sidepro service port-forward my-service 8080

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

sidepro service bind SERVICE_NAME APP_NAME

Bind a service to an application. Note that the application will be restarted after binding.

USAGE
  $ sidepro service bind SERVICE_NAME APP_NAME

ARGUMENTS
  SERVICE_NAME  Name of the service to bind
  APP_NAME      Name of the application to bind the service to

DESCRIPTION
  Bind a service to an application. Note that the application will be restarted after binding.

See code: src/commands/service/bind.ts

sidepro service catalog [SERVICE_NAME]

Lists all available SidePro Cloud services, or show the details of the specified one.

USAGE
  $ sidepro service catalog [SERVICE_NAME]

ARGUMENTS
  SERVICE_NAME  Name of the service

DESCRIPTION
  Lists all available SidePro Cloud services, or show the details of the specified one.

See code: src/commands/service/catalog.ts

sidepro service create CATALOG_NAME SERVICE_NAME

Create a new service that can be bound to one or more applications. The service will be provisioned from the catalog.

USAGE
  $ sidepro service create CATALOG_NAME SERVICE_NAME [-w] [-v <value>...]

ARGUMENTS
  CATALOG_NAME  Name of the service item from the catalog
  SERVICE_NAME  Name of the service to create

FLAGS
  -v, --chart-value=<value>...  Values to set for the service
  -w, --wait                    Wait until the service is ready

DESCRIPTION
  Create a new service that can be bound to one or more applications. The service will be provisioned from the catalog.

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

sidepro service delete [SERVICE_NAME]

Delete the specified service(s). Can take a list of service names.

USAGE
  $ sidepro service delete [SERVICE_NAME] [-a] [-u]

ARGUMENTS
  SERVICE_NAME  Name of the service to delete

FLAGS
  -a, --all     Delete all services under the account
  -u, --unbind  Unbind the service from all applications before deleting

DESCRIPTION
  Delete the specified service(s). Can take a list of service names.

See code: src/commands/service/delete.ts

sidepro service list

Lists all currently provisioned services under the account.

USAGE
  $ sidepro service list

DESCRIPTION
  Lists all currently provisioned services under the account.

ALIASES
  $ sidepro services

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

sidepro service open SERVICE_NAME

Open the specified provisioned service in the browser.

USAGE
  $ sidepro service open SERVICE_NAME [-s]

ARGUMENTS
  SERVICE_NAME  Name of the service

FLAGS
  -s, --show  Show the service details instead of opening the browser

DESCRIPTION
  Open the specified provisioned service in the browser.

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

sidepro service port-forward SERVICE_NAME LOCAL_PORT

Forward a local port to a service.

USAGE
  $ sidepro service port-forward SERVICE_NAME LOCAL_PORT [--address <value>]

ARGUMENTS
  SERVICE_NAME  Name of the service
  LOCAL_PORT    Local port to forward

FLAGS
  --address=<value>  [default: localhost] Addresses to listen on (comma separated)

DESCRIPTION
  Forward a local port to a service.

See code: src/commands/service/port-forward.ts

sidepro service show SERVICE_NAME

Show the details of the specified provisioned service.

USAGE
  $ sidepro service show SERVICE_NAME

ARGUMENTS
  SERVICE_NAME  Name of the service

DESCRIPTION
  Show the details of the specified provisioned service.

See code: src/commands/service/show.ts

sidepro service unbind SERVICE_NAME APP_NAME

Unbind a service from an application. Note that the application will be restarted after unbinding.

USAGE
  $ sidepro service unbind SERVICE_NAME APP_NAME

ARGUMENTS
  SERVICE_NAME  Name of the service to unbind
  APP_NAME      Name of the application to unbind the service from

DESCRIPTION
  Unbind a service from an application. Note that the application will be restarted after unbinding.

See code: src/commands/service/unbind.ts

sidepro service update SERVICE_NAME

Update service by name and change instructions through flags.

USAGE
  $ sidepro service update SERVICE_NAME [-s <value>...] [-u <value>...]

ARGUMENTS
  SERVICE_NAME  Name of the service to update

FLAGS
  -s, --set=<value>...    Configuration key/value assignments to add/modify
  -u, --unset=<value>...  Configuration keys to remove

DESCRIPTION
  Update service by name and change instructions through flags.

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

sidepro services

Lists all currently provisioned services under the account.

USAGE
  $ sidepro services

DESCRIPTION
  Lists all currently provisioned services under the account.

ALIASES
  $ sidepro services

sidepro update [CHANNEL]

update the sidepro CLI

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

FLAGS
  -a, --available        See 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 sidepro CLI

EXAMPLES
  Update to the stable channel:

    $ sidepro update stable

  Update to a specific version:

    $ sidepro update --version 1.0.0

  Interactively select version:

    $ sidepro update --interactive

  See available versions:

    $ sidepro update --available

See code: @oclif/plugin-update