--- title: OCP CLI command reference slug: optimizely-connect-platform/docs/ocp-cli-command-reference docTags: createdAt: 2026-07-23T12:37:04.247Z --- This page lists every available Optimizely Connect Platform (OCP) command-line interface (CLI) command, with parameters, flags, and options. To install and configure the OCP CLI, see [Configure your OCP development environment](docId\:TBNojk2UclFnAMYVTs-6h). ## OCP CLI help command Commands are grouped into namespaces. ```shell $ ocp -h Usage: ocp Namespaces: (`` -h, --help for additional help) accounts app availability dev-server directory env jobs review Commands: autocomplete Display autocomplete installation instructions dev Start the local development server for OCP apps update Update the OCP CLI ``` Run the help command, `-h` or `--help`, to list commands in a namespace. See the following example: ```shell $ ocp app -h Usage: ocp app Commands: init Create a new app project logs Fetch app logs package Prepare a package for manual upload prepare Validate, package, upload and build an app to prepare for publishing register Register an app version validate Validate an app locally ocp -h, --help for help on specific commands ``` Adding the help context on a command displays documentation for the command with all available options. See the following example: ```shell $ ocp app prepare -h Usage: ocp app prepare [] [--noProgress | --no-progress] [--upgradeDeps | --upgrade-deps] [--publish] [--usePreviousAppEnvValues | --use-previous-app-env-values] [--bumpDevVersion | --bump-dev-version] Parameters: path The root directory of the app Flags: --noProgress, --no-progress Don't display any progress indicators --upgradeDeps, --upgrade-deps Automatically update dependencies --publish Automatically publish if the upload is successful --usePreviousAppEnvValues Use app env values (.env file) from the previous version of the app. Any values in local .env file are ignored --bumpDevVersion Bump dev version before building. Allows quickly testing dev versions ``` ## OCP CLI commands The following table lists all available OCP CLI commands with their parameters and descriptions: | Command | Parameters | Description | | ---------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ocp -h` | N/A | The help context for the OCP CLI is `-h`. It provides information about your environment when you run `ocp -h` and provides contextual help when you add `-h` after any command. | | `ocp -v` or `ocp --version` | N/A | Displays the installed OCP CLI version. | | `ocp autocomplete` | N/A | Displays shell autocompletion installation instructions. Supports Bash, Zsh, and PowerShell, with PowerShell 7+ for Windows. Run the command and follow the instructions provided in the terminal. | | `ocp update` | N/A | Updates the OCP CLI to the latest version. You can append `--available` to display the list of available versions. | | `ocp accounts whoami` | N/A | Returns your developer profile, the OCP and ODP accounts you can reach, and any CMS (SaaS) instances, grouped by organization. It also returns your personal and vendor apps. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp accounts whois` | `` | Searches the accounts you can access in one availability zone. Returns the ID, tracker ID, name, and target product of each match. Requires a search term, for example, `ocp accounts whois acme`. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app init` | `` | Creates a new app project and initializes the app. Requires the app ID, for example, `ocp app init `. | | `ocp app logs` | `` or `` | Returns app logs. Requires the app ID or build ID, for example, `ocp app logs `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app getLogLevel` or `ocp app get-log-level` | `` | Returns the log level for the app version that you specify. Requires the app ID and version in the following format: ``. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app setLogLevel` or `ocp app set-log-level` | ` ` | Sets the log level for the app version that you specify. Options are `debug`, `info`, `warn`, `error`, `never`. Requires the app ID and version in the following format: ``. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app package` | `` | Prepares a package for manual upload. Requires the path for the root directory of the app, for example, `ocp app package `. | | `ocp app prepare` | `` | Validates, packages, uploads, and builds an app to prepare for publishing. Requires the path for the root directory of the app, for example, `ocp app prepare `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app register` | ` ` | Registers an app version. Requires the app ID and name, for example, `ocp app register `. You can append `--availability` or `--a` to define the availability region to which the app is registered (default is `US`). | | `ocp app validate` | `` | Validates an app locally. Requires the path for the root directory of the app, for example, `ocp app validate `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app abandon` | `` | Ceases the processing of the specified app version that you have not published yet. You can append --noPrompt or --no-prompt to use the default answer (yes) to any prompt question, except for destructive operations. For example, `ocp app abandon `. | | `ocp app deploy` | N/A | (Experimental). Builds and publishes an app version to a [preview track](docId\:gLoc5c6DPRHSfUcBL6bpf) in one step. Defaults to the `dev/USERNAME` track and derives the version from the content of the app. Run it from the app directory, for example, `ocp app deploy --preview-track beta/feature-x`. To release a semantic version (semver) instead, which builds the release version and starts a review, append `--version`, for example, `ocp app deploy --version 1.2.0`. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app deploy list` | N/A | (Experimental). Lists an app's versions grouped by preview track, with semver releases in their own group. Append `--appId` or `--app-id` to name the app instead of reading `app.yml`, and `--previewTrack` or `--preview-track` to show one track. | | `ocp app promote` | N/A | (Experimental). Promotes a preview version onto another preview track without building it again, or releases it as a semver version, which builds the release version and starts a review. To release your working directory instead, use `ocp app deploy --version`. Requires `--from` and `--to`, for example, `ocp app promote --from dev/jdoe --to beta/release-1.2`. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app rollback` | N/A | (Experimental). Returns a preview track to an earlier version and moves the installations that follow the track onto it. Defaults to the version the track ran before its current one, for example, `ocp app rollback --preview-track dev/jdoe`. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp app rollback list` | N/A | (Experimental). Lists a preview track's versions newest-first, marks the current one, and shows which versions are still rollback targets. Append `--previewTrack` or `--preview-track` and `--appId` or `--app-id`. | | `ocp availability list` | N/A | Lists all availability regions (`US`, `EU`, `AU`). | | `ocp dev` | N/A | Starts the local development server for OCP apps. This is a quick-start command. For more configuration options, use `ocp dev-server start`. | | `ocp dev-server start` | N/A | Starts the local development server with configuration options. Optionally specify the path to the OCP app root directory. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp directory unpublish` | `` | Unpublishes an app version (uninstalls everywhere and undeploys). Requires the app ID and version in the following format: ``. For example, `ocp directory unpublish `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp directory publish` | `` | Publishes (makes available) a specific app version that has been reviewed and approved. Requires the app ID and version in the following format: ``. For example, `ocp directory publish `. You can append `--noProgress` or `--no-progress`. | | `ocp directory info` | `` | Gets information about an app. Requires the app ID, for example, `ocp directory info `. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory install` | ` []` | Installs a specific app version into an account. Requires the app ID and version (in the following format: ``), and the tracker ID of the account to which you want to install the app. For example, `ocp directory install `. For CMS UI extension apps, use `--scope INSTANCE_ID` instead of the tracker ID to specify the CMS instance. If you are not provided with a scope, select it interactively. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). To follow a [preview track](docId\:gLoc5c6DPRHSfUcBL6bpf) instead of pinning a version, pass the app ID without a version and append `--previewTrack` or `--preview-track`, for example, `ocp directory install my_app --preview-track dev/jdoe TRACKER_ID`. | | `ocp directory list` | `` | Lists registered app versions. Lists all apps by default if you do not define the app ID, for example, `ocp directory list `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp directory listFunctions` or `ocp directory list-functions` | ` []` | Lists the functions exposed by an app installation. Requires the app ID and tracker ID, for example, `ocp directory listFunctions `. For CMS UI extension apps, use `--scope INSTANCE_ID` instead of the tracker ID to specify the CMS instance. If you are not provided with a scope, select it interactively. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory listGlobalFunctions` or `ocp directory list-global-functions` | `` | Lists the global functions exposed by an app. Requires the app ID, for example, `ocp directory listGlobalFunctions `. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory listInstalls` or `ocp directory list-installs` | `` | Lists installations of a specific app version. Requires the app ID and version (in the following format: ``). For example, `ocp directory listInstalls `. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory status` | `` | Gets the status of a particular app ID and version. Requires the app ID and version (in the following format: ``). For example, `ocp directory status `. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory uninstall` | ` []` | Uninstalls an app from an account. Requires the app ID and tracker ID, for example, `ocp directory uninstall `. For CMS UI extension apps, use `--scope INSTANCE_ID` instead of the tracker ID to specify the CMS instance. If you are not provided with a scope, select it interactively. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `ocp directory upgrade` | ` []` | Upgrades the install to a specific app version. Requires the app ID and tracker ID, for example, `ocp directory upgrade `. For CMS UI extension apps, use `--scope INSTANCE_ID` instead of the tracker ID to specify the CMS instance. If you are not provided with a scope, select it interactively. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp env get` | N/A | Gets the current environment of the OCP CLI. | | `ocp env set` | `` | Sets the current environment for the OCP CLI. Requires the environment name. | | `ocp jobs list` | `` | Lists jobs. Requires the app ID for which you want to view jobs, for example, `ocp jobs list `. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp jobs terminate` | `` | Terminates a job. Requires the ID of the job to terminate. You can append `--availability` or `--a` to define the availability region (default is `US`). | | `ocp jobs trigger` | ` []` | Triggers a job. Requires the app ID and version (in the following format: ``), job name, and tracker ID of the account for which you want to trigger the job. For example, `ocp jobs trigger `. For CMS UI extension apps, use `--scope INSTANCE_ID` instead of the tracker ID to specify the CMS instance. If you are not provided with a scope, select it interactively. See [additional flags and options](docId\:VjYHrbeUvGtaYYd8SqIIt). | | `ocp review list` | `` | Lists app versions currently under review. You can optionally define the app ID of the app for which you want to view versions under review (for example, `ocp review list `. Lists all apps by default. | | `ocp review open` | `` | Opens a review in your browser. Requires the app ID and version (in the following format: ``). For example, `ocp review open ` | ### Additional flags and options for OCP CLI commands You can append various flags and options for some of the OCP CLI commands. For commands that accept `--scope`, the CLI prompts you to select a CMS instance if you omit the flag. To trigger the prompt explicitly, pass `--scope=` with an empty value. The `--scope` flag applies to CMS UI extension apps only. `ocp accounts whoami` - `--json` – Outputs your raw profile and account access as JSON, and writes warnings to `stderr` so that `stdout` contains only JSON. - `--noProgress` or `--no-progress` – Do not display any progress indicators. `ocp accounts whois` - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp app logs` - `--tail` – Tails the logs. - `--appId` - `--buildId` - `--appVersion` - `--trackerId` - `--scope` or `-s` – Specific CMS instance ID to filter by. - `--jobId` - `--installId` - `--from` – A start time as an ISO string, an epoch timestamp, or relative string (for example, `5m` for 5 minutes). Default is `24h`. - `--to` – An end time as an ISO string, an epoch timestamp, or relative string (for example, `5m` for 5 minutes). - `--search` – String to search for in log messages. Can be specified multiple times. - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp app getLogLevel`**or**`ocp app get-log-level` - `--trackerId` – Specific Tracker ID to filter by. - `--scope` or `-s` – CMS instance ID of the installation to target. - `--availability` – The availability region that is targeted (default is `US`). `ocp app setLogLevel`**or**`ocp app set-log-level` - `--trackerId` – Specific Tracker ID to filter by. - `--scope` or `-s` – CMS instance ID of the installation to target. - `--timeToLive` – Expiration period for the log level as a relative string (for example, `5m` for 5 minutes). Default is 2 hours (`2h`). - `--availability` – The availability region that is targeted (default is `US`). `ocp app prepare` - `--noProgress` or `--no-progress` – Do not display any progress indicators. - `--upgradeDeps` or `--upgrade-deps` – Automatically update dependencies. - `--publish` – Automatically publish if the upload is successful. - `--usePreviousAppEnvValues` or `--use-previous-app-env-values` – Use app env values (*.env* file) from the previous version of the app. Any values in the local *.env* is ignored. - `--bumpDevVersion` or `--bump-dev-version` – Bump dev version before building. Lets you quickly test dev versions. `ocp app deploy` (experimental) - `--previewTrack` or `--preview-track` – Preview track to deploy to. Defaults to `dev/USERNAME`. - `--version` – Release this semver version instead of deploying to a preview track, such as `1.2.0`. Builds the release version from your working directory and starts a review. Cannot be combined with `--previewTrack`, `--force`, or `--rcDependencies`. - `--watch` – With `--version`, wait for review approval and publish when it arrives. - `--force` or `-f` – Build a version even when identical source is already deployed. - `--rcDependencies` or `--rc-dependencies` – Build with the unstable release candidate (RC) OCP dependency set. - `--upgradeDeps` or `--upgrade-deps` – Automatically update out-of-date OCP dependencies. - `--noPrompt` or `--no-prompt` – Use the default answer for any prompt. - `--noProgress` or `--no-progress` – Do not display any progress indicators. - `--path` or `-p` – The root directory of the app. `ocp app promote` (experimental) - `--from` – Source track, whose current version is promoted, or an explicit version such as `dev/jdoe/abc1234`. Required. - `--to` – Target preview track, such as `beta/release-1.2`, or semver release, such as `1.2.0`. Required. - `--watch` – For a semver release, wait for review approval and publish when it arrives. - `--appId` or `--app-id` – App ID to promote. Defaults to the `app.yml` in the current directory. - `--noProgress` or `--no-progress` – Do not display any progress indicators. - `--path` or `-p` – The root directory of the app. `ocp app rollback` (experimental) - `--previewTrack` or `--preview-track` – Preview track to roll back. Defaults to `dev/USERNAME`. - `--to` – Hash to roll back to, such as `abc1234`. Defaults to the version the track ran before its current one. - `--appId` or `--app-id` – App ID to roll back. Defaults to the `app.yml` in the current directory. - `--noProgress` or `--no-progress` – Do not display any progress indicators. - `--path` or `-p` – The root directory of the app. `ocp app validate` - `--noProgress` or `--no-progress` – Do not display any progress indicators. - `--upgradeDeps` or `--upgrade-deps` – Automatically update dependencies. `ocp dev-server start` - `--port` or `-p` – Port to run the server on (default: 3000). - `--verbose` or `-v` – Enable verbose logging. - `--noOpen` or `--no-open` – Do not automatically open the browser. - `--config` or `-c` – Path to custom configuration file. - `--path` – Path to the OCP app root directory. `ocp directory unpublish` - `--force` or `-f` - `--noProgress` or `--no-progress` - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp directory publish` - `--noProgress` or `--no-progress` `ocp directory list` - `--allStatuses` – Includes all statuses. The **stopped** status is not included by default. - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp directory install` - `--scope` or `-s` – CMS instance ID of the installation to target. - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp directory listFunctions` - `--scope` or `-s` – CMS instance ID of the installation to target. - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp directory uninstall` - `--scope` or `-s` – CMS instance ID of the installation to target. - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp directory upgrade` - `--scope` or `-s` – CMS instance ID of the installation to target. - `--toVersion` or `-v` – The desired version (for example, 1.0.0). - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp jobs list` - `--version` – Specific versions to filter by. - `--trackerId` – Specific Tracker IDs to filter by. - `--scope` or `-s` – Specific CMS instance ID to filter by. - `--function` – Specific job function to filter by. - `--status` – Specific job status to filter by. Possible values include the following: `PENDING`, `SCHEDULED`, `RUNNING`, `COMPLETE`, `ERROR`, `TERMINATED`. - `--minDuration` – Display jobs that were running longer than the given duration (for example, `5m` = 5 minutes). - `--sortBy` – Column to sort the jobs by. Possible values include the following: `id`, `function`, `trackerId`, `status`, `error`, `createdAt`, `triggeredAt`, `scheduledAt`, `terminatedAt`, `updatedAt`, `duration`. The default column to sort by is `updatedAt`. - `--sortDirection` – Sort resulting jobs in ascending or descending order. Possible values include the following: `asc` or `desc`. The default sort direction is `asc`. - `--limit` – Number of jobs to list. The default is 50. - `--columns` – Columns to display. Possible values include the following: `id`, `version`, `function`, `trackerId`, `trigger`, `status`, `error`, `createdAt`, `triggeredAt`, `scheduledAt`, `terminatedAt`, `updatedAt`, `duration`. The default columns are `id`, `version`, `function`, `trackerId`, `status`, `updatedAt`. - `--from` – A start time as an ISO string, an epoch timestamp, or relative string (for example, `5m` = 5 minutes). The default time value is `24h`. - `--to` – An end time as an ISO string, an epoch timestamp, or relative string (for example, `5m` = 5 minutes). - `--availability` or `-a` – The availability region that is targeted (default is `US`). `ocp jobs trigger` - `--scope` or `-s` – CMS instance ID of the installation to target. - `--parameters` – Parameters to pass to the job. - `--availability` or `-a` – The availability region that is targeted (default is `US`).