--- title: Configure your development environment slug: data-platform/connect-platform/ocp-get-started-development-environment docTags: createdAt: 2026-08-05T20:06:34.632Z --- Develop, manage, and publish a Connect Platform for Optimizely Data Platform (ODP) app using the Connect Platform for ODP command-line interface (CLI). You can configure the OCP CLI on either a [Mac/Linux machine](docId\:u0s1BJDT5n0I6BGY9pLWF) or a [Windows machine](docId\:u0s1BJDT5n0I6BGY9pLWF). Skip directly to the section that pertains to your environment. :::hint{type="info"} **Note** If you are migrating from OCP CLI v1, see the [OCP CLI v2 migration guide](docId:7UYu9f1rF2CBbgKe8sP6I) for instructions on uninstalling v1 and upgrading to v2. ::: ## Prerequisites - A [Connect Platform for ODP developer account](docId\:SKZx_xA5w2geOH6iwyRJF). - The API key from your invitation email. - Node.js 22+ JavaScript runtime environment, required for app development. Find your platform-specific installer [on the Node.js site](https://nodejs.org/download/release/v22.9.0/), or use your preferred Node version manager for the installation. - A package manager for app development. Apps running Node.js 22+ support Yarn, Yarn Berry, npm, pnpm, and Bun. Apps on older runtimes require Yarn 1. See the [Yarn global installation instructions](https://classic.yarnpkg.com/lang/en/docs/install) or, if you are on Windows, [install Yarn through Corepack](https://yarnpkg.com/getting-started/install). :::hint{type="info"} **Note** If your app uses Node.js 22+ and you want to migrate from Yarn 1 to a different package manager, see the [Package manager migration guide](docId\:phuhyycK8yV0Wo5EcqHlb). ::: - The OCP CLI requires Git to build an app. Find global install instructions for Git [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). :::hint{type="info"} **Note** If you are not planning to build an app, you can skip the Git install. ::: ## Configure the OCP CLI for Mac/Linux 1. Run the following command to make a `.ocp` directory: ```shell mkdir ~/.ocp (home dir) ``` 2. Using the API key you received during onboarding, create the credentials file in the `.ocp` directory: ```shell echo '{"apiKey": ""}' > ~/.ocp/credentials.json ``` 3. Run the following script to install the OCP CLI: ```bash curl -fsSL https://cli.ocp.optimizely.com/install.sh | bash ``` The script downloads the latest OCP CLI release, verifies the tarball checksum, installs it to `~/.local/share/ocp`, and adds the `ocp` binary to your `PATH`. The CLI ships with its own runtime, so it operates independently of any local Node.js installation. ## Configure the OCP CLI for Windows :::hint{type="info"} **Note** The following instructions are for PowerShell. ::: 1. Run the following command to make a `.ocp` directory: ```powershell New-Item -Path "~/.ocp" -Name "home dir" -ItemType "directory" ``` 2. Using the API key you received during onboarding, create the credentials file in the `.ocp` directory: ```powershell Write-Output '{"apiKey": ""}' | out-file "~/.ocp/credentials.json" -encoding utf8 ``` 3. Run the following PowerShell script to install the OCP CLI: ```powershell iwr -useb https://cli.ocp.optimizely.com/install.ps1 | iex ``` The script downloads the latest OCP CLI release, verifies the tarball checksum, installs it to `$env:LOCALAPPDATA\ocp`, and adds the `ocp` binary to your `PATH`. The CLI ships with its own runtime, so it operates independently of any local Node.js installation. ## Test your OCP CLI configuration Verify your OCP CLI configuration by running the following command: ```shell ocp accounts whoami ``` The results should look similar to the following: ```shell $ ocp accounts whoami id: e1006b36-183e-4951-912c-416012f5a882 email: john.smith@mycompany.com role: developer githubUsername: jonhsmith accounts: - 7b5d1518a0be personal_apps: [] vendor: mycompany vendor_apps: [] ``` ## (Optional) Configure PowerShell autocomplete The OCP CLI supports shell autocomplete for Bash, Zsh, and PowerShell, with PowerShell 7+ for Windows. To configure autocomplete, run the following command and follow the instructions displayed in the terminal: ```shell ocp autocomplete ``` Restart your shell or source the relevant configuration file after configuration. Press `Tab` while entering an `ocp` command to autocomplete commands and subcommands. To autocomplete flags, enter `-` and press `Tab`. Press `Tab` twice to display all available options for the current input. ## OCP CLI help command Commands are grouped into namespaces: ```shell $ ocp -h Usage: ocp Namespaces: (`` -h, --help for additional help) accounts app availability 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-previous-app-env-values Use app env values (.env file) from the previous version of the app. Any values in local .env file will be ignored --bumpDevVersion, --bump-dev-version Bump dev version before building. Allows quickly testing dev versions ``` ### Run OCP CLI commands using `npx` You can also run OCP CLI commands directly using `npx`, without requiring any installation. However, ensure your shell has the correct Node.js runtime version for the application to function as expected. See the following example: ```bash npx @optimizely/ocp-cli-v2 app init npx @optimizely/ocp-cli-v2 app validate npx @optimizely/ocp-cli-v2 app package ``` ## OCP CLI commands The table below lists all available OCP CLI commands with their parameters and descriptions. | Command | Parameters | Description | | ---------------------------------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ocp -h` | N/A | The help context for the 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 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 CLI to the latest version. You can append `--available` to display the list of available versions. | | `ocp accounts whoami` | N/A | Returns your account information. | | `ocp accounts whois` | `` | Returns basic account information for a specific user. Requires a user input, for example, `ocp accounts whois "user"`. | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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 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\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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 `. You can append `--availability` or `--a` to define the availability region of the app (default is `US`). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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 `. 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 `. 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 `. See [additional flags and options](docId\:u0s1BJDT5n0I6BGY9pLWF). | | `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\:u0s1BJDT5n0I6BGY9pLWF). | | `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 `. See [additional flags and options](docId\:u0s1BJDT5n0I6BGY9pLWF). | | `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/options for OCP CLI commands You can append various flags/options for some of the OCP CLI commands, listed below. `ocp app logs` - `--tail` – Tails the logs. - `--appId` - `--buildId` - `--appVersion` - `--trackerId` - `--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 will be targeted (default is US). `ocp app getLogLevel` **or** `ocp app get-log-level` - `--trackerId` – Specific Tracker ID to filter by. - `--availability` – The availability region that will be targeted (default is US). `ocp app setLogLevel` **or** `ocp app set-log-level` - `--trackerId` – Specific Tracker ID to filter by. - `--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 will be 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* file will be ignored. - `--bumpDevVersion` or `--bump-dev-version` – Bump dev version before building. Allows you to quickly test dev versions. `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 will be 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 will be targeted (default is US). `ocp directory upgrade` - `--toVersion` or `-v` – The desired version (for example, 1.0.0). - `--availability` or `-a` – The availability region that will be targeted (default is US). `ocp jobs list` - `--version` – Specific versions to filter by. - `--trackerId` – Specific Tracker IDs 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` - `--parameters` – Parameters to pass to the job. - `--availability` or `-a` – The availability region that will be targeted (default is US). ## Uninstall OCP CLI If you want to completely remove OCP CLI from your system, run the following script for MacOS or Linux: ```bash rm -rf ~/.local/share/ocp ~/.local/bin/ocp ``` Run the following script for Windows: ```powershell Remove-Item -Recurse -Force "$env:LOCALAPPDATA\ocp" ```