--- name: codeengine-getting-started-cli title: Getting started with the Code Engine CLI description: You can use the IBM Cloud® Code Engine API to create and manage your Code Engine entities. last-updated: 2026-07-17 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/codeengine?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Getting started with the Code Engine CLI {: #cecli-getstart} You can use the IBM Cloud® Code Engine API to create and manage your Code Engine entities. {: shortdesc} - [Set up your Code Engine CLI environment](https://cloud.ibm.com/docs/codeengine?topic=codeengine-install-cli&format=markdown). - [Create and work with a project](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project&format=markdown). ## Setting up your CLI environment {: #cecli-getstart-setup} To work with the CLI to create and manage Code Engine entities, set up your CLI environment. Make sure you have the latest version of the IBM Cloud CLI installed. Before you begin You must create an [IBM Cloud account](https://cloud.ibm.com/){: external}. 1. Download and install the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started&format=markdown). 2. Log in to the IBM Cloud CLI. 1. Log in to the IBM Cloud CLI. ```txt ibmcloud login ``` {: pre} 2. If you have more than one account, you are prompted to select which account to use. Follow the prompts or use the **`target`** command to select your IBM Cloud account. ```txt ibmcloud target -c ``` {: pre} 3. Specify a region. Use the **`target`** command to target or change regions. ```txt ibmcloud target -r ``` {: pre} 4. Specify a resource group. To get a list of your resource groups, run the following command. ```txt ibmcloud resource groups ``` {: pre} Example output ```txt Retrieving all resource groups under account as email@ibm.com... OK Name ID Default Group State default a8a12accd63b437bbd6d58fb8b462ca7 true ACTIVE test a8a12abbbd63b437cca6d58fb8b462ca7 false ACTIVE ``` {: screen} 5. Target a resource group by running the following command. ```txt ibmcloud target -g ``` {: pre} Example output ```txt Targeted resource group default ``` {: screen} 3. Install the Code Engine CLI plug-in. ```txt ibmcloud plugin install code-engine ``` {: pre} 4. Verify that the Code Engine CLI plug-in is installed. You can use the **`ibmcloud code-engine version`** command or the **`ibmcloud plugin list`** command to confirm that the plug-in is installed. ```txt ibmcloud code-engine version ``` {: pre} Example output ```txt OK version: v1.54.2 commit: e4800be63b1077563bdbaee9e656ce1f81c3e08d ``` {: screen} 5. Run the **`ibmcloud ce help`** command to view the commands for the Code Engine CLI. For example, ```txt ibmcloud ce help ``` {: pre} ## Working with the Code Engine CLI {: #cecli-getstart-workcecli} Now that your Code Engine CLI environment is set up, you are ready to work with Code Engine resources, such as applications, functions, or jobs with the CLI. Before you can work with Code Engine resources, you must work within the context of a project. A project is a grouping of Code Engine entities such as applications, functions, jobs, fleets, and builds. A project is based on a Kubernetes namespace. The name of your project must be unique within your IBM Cloud® resource group, user account, and region. Projects are used to manage resources and provide access to their entities. A project provides the following capabilities: - A unique namespace for entity names. - Management of inbound access to project resources. - Management of outbound access to backing services, registries, and repositories. - An automatically generated certificate for Transport Layer Service (TLS). For more information about Code Engine projects, see [Managing projects](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project&format=markdown). 1. Create a project with the [**`project create`**](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown#cli-project-create) command. Use a project name that is unique to your region. ```txt ibmcloud ce project create --name PROJECT_NAME ``` {: pre} Example output ```txt Creating project 'myproject'... OK ``` {: screen} 2. View details about the project with the [**`project get`**](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown#cli-project-get) command. ```txt ibmcloud ce project get --name PROJECT_NAME ``` {: pre} Example output ```txt Getting project 'myproject'... OK Name: myproject ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Status: active Selected: true Region: us-south Resource Group: default Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f Age: 52d Created: Fri, 15 Jan 2021 13:32:30 -0500 Updated: Fri, 15 Jan 2021 13:32:45 -0500 Quotas: Category Used Limit App revisions 1 100 Apps 1 100 Build runs 0 100 Builds 0 100 Configmaps 2 100 CPU 1.025 64 Ephemeral storage 902625Ki 256G Instances (active) 1 250 Instances (total) 2 2500 Job runs 1 100 Jobs 1 100 Memory 4400M 256G Secrets 5 100 Subscriptions (cron) 0 100 Subscriptions (IBM Cloud Object Storage) 0 100 ``` {: screen} Alternatively, you can use the [**`project list`**](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown#cli-project-list) command to display a list of your created projects. To work with a project with the CLI, the project must be selected as the current context. A project is automatically selected as the current context when it is created, unless you specify the `--no-select` option. To select a project that is not currently targeted, use the [**`project select`**](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown#cli-project-select) command. {: note} For more information about working with projects, see [Managing projects](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project&format=markdown). ## Next steps {: #cecli-getstart-next} Now that you have setup your CLI environment, and have taken the first steps to ensure that you are working within the context of a Code Engine project, you can use the Code Engine CLI to work with apps, functions, and jobs. To start working with Code Engine components with the CLI, see the following topics. * [Working with apps](https://cloud.ibm.com/docs/codeengine?topic=codeengine-application-workloads&format=markdown). * [Working with functions](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-work&format=markdown) * [Working with jobs](https://cloud.ibm.com/docs/codeengine?topic=codeengine-job-plan&format=markdown) For more information about the Code Engine CLI, see the [Setting up the CLI environment](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown). For more information about working in the Code Engine CLI environment, see [Code Engine CLI Command Reference documentation](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli&format=markdown). For a summary of changes for each version of the CLI, see [CLI version history](https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli_versions&format=markdown). Be sure to keep your CLI up-to-date so that you can use all the available commands and their options.