IBM Cloud CLI

IBM Cloud CLI Commands Cheat Sheet

Practical IBM Cloud CLI commands for authentication, IAM, resource groups, VPC, Kubernetes, Code Engine, Container Registry, Object Storage, databases and DevOps workflows.

Showing 137 commands.

IBM Cloud CLI Setup and Version

ibmcloud -v

Display the installed IBM Cloud CLI version.

ibmcloud help

Display IBM Cloud CLI help and available commands.

ibmcloud update

Update the IBM Cloud CLI to the latest version.

ibmcloud config --list

Display current IBM Cloud CLI configuration.

IBM Cloud Login and Authentication

ibmcloud login

Log in to IBM Cloud interactively.

ibmcloud login --sso

Log in using a federated IBM Cloud identity.

ibmcloud login --apikey <api_key>

Log in using an IBM Cloud API key.

ibmcloud logout

Log out from the current IBM Cloud session.

ibmcloud target

Display the current targeted account, resource group and region.

ibmcloud target -r us-south

Target a specific IBM Cloud region.

ibmcloud target -g <resource_group>

Target a specific resource group.

IBM Cloud Plugins

ibmcloud plugin list

List installed IBM Cloud CLI plugins.

ibmcloud plugin repos

List configured plugin repositories.

ibmcloud plugin repo-plugins

List plugins available from configured repositories.

ibmcloud plugin install <plugin>

Install an IBM Cloud CLI plugin.

ibmcloud plugin install <plugin> -v <version>

Install a specific plugin version.

ibmcloud plugin update

Check for and update installed plugins.

ibmcloud plugin update --all

Update all available plugins.

ibmcloud plugin uninstall <plugin>

Remove an installed plugin.

ibmcloud plugin show <plugin>

Show details about an installed plugin.

IBM Cloud Accounts and Resource Groups

ibmcloud account show

Display information about the current IBM Cloud account.

ibmcloud resource groups

List resource groups.

ibmcloud resource group

Display the current targeted resource group.

ibmcloud resource group-create <name>

Create a resource group.

ibmcloud resource group-update <name>

Update a resource group.

ibmcloud resource group-delete <name>

Delete a resource group.

IBM Cloud IAM

ibmcloud iam service-id <name>

Create a service ID.

ibmcloud iam service-ids

List service IDs.

ibmcloud iam service-id-delete <id>

Delete a service ID.

ibmcloud iam service-api-key-create <service_id> <name>

Create an API key for a service ID.

ibmcloud iam service-api-keys <service_id>

List API keys for a service ID.

ibmcloud iam api-keys

List API keys associated with the current user.

ibmcloud iam user-policies <user>

List IAM policies for a user.

IBM Cloud Resources

ibmcloud resource service-instances

List service instances in the targeted resource group.

ibmcloud resource service-instance <name>

Display details for a service instance.

ibmcloud resource service-instance-create <name> <service> <plan> <location>

Create a service instance.

ibmcloud resource service-instance-delete <name>

Delete a service instance.

ibmcloud resource service-aliases

List service aliases.

ibmcloud resource service-bindings <service_instance>

List service bindings.

IBM Cloud Catalog

ibmcloud catalog search <keyword>

Search the IBM Cloud catalog.

ibmcloud catalog service <service>

Display details about a catalog service.

ibmcloud catalog service-marketplace <service>

Show marketplace information for a service.

IBM Cloud Object Storage

ibmcloud cos buckets

List Object Storage buckets using the COS plugin.

ibmcloud cos bucket-create --bucket <bucket_name>

Create an Object Storage bucket.

ibmcloud cos bucket-delete --bucket <bucket_name>

Delete an Object Storage bucket.

ibmcloud cos objects --bucket <bucket_name>

List objects in a bucket.

ibmcloud cos object-head --bucket <bucket_name> --key <object>

Display metadata for an object.

ibmcloud cos object-delete --bucket <bucket_name> --key <object>

Delete an object from a bucket.

IBM Cloud VPC

ibmcloud is vpcs

List IBM Cloud VPCs.

ibmcloud is vpc-create <name>

Create a VPC.

ibmcloud is vpc <id>

Display VPC details.

ibmcloud is vpc-delete <id>

Delete a VPC.

ibmcloud is subnets

List VPC subnets.

ibmcloud is subnet <id>

Display subnet details.

ibmcloud is security-groups

List VPC security groups.

ibmcloud is security-group-rules <security_group_id>

List security group rules.

IBM Cloud VPC Virtual Servers

ibmcloud is instances

List VPC virtual server instances.

ibmcloud is instance <id>

Display virtual server details.

ibmcloud is instance-create

Create a VPC virtual server instance.

ibmcloud is instance-start <id>

Start a virtual server instance.

ibmcloud is instance-stop <id>

Stop a virtual server instance.

ibmcloud is instance-reboot <id>

Reboot a virtual server instance.

ibmcloud is instance-delete <id>

Delete a virtual server instance.

IBM Cloud VPC Images and Volumes

ibmcloud is images

List available VPC images.

ibmcloud is image <id>

Display image details.

ibmcloud is volumes

List block storage volumes.

ibmcloud is volume <id>

Display volume details.

ibmcloud is volume-create <name>

Create a block storage volume.

ibmcloud is volume-delete <id>

Delete a block storage volume.

IBM Cloud Load Balancers

ibmcloud is load-balancers

List VPC load balancers.

ibmcloud is load-balancer <id>

Display load balancer details.

ibmcloud is load-balancer-create

Create a VPC load balancer.

ibmcloud is load-balancer-delete <id>

Delete a load balancer.

IBM Cloud Kubernetes Service

ibmcloud plugin install container-service

Install the IBM Cloud Kubernetes Service CLI plugin.

ibmcloud ks clusters

List IBM Cloud Kubernetes Service clusters.

ibmcloud ks cluster get --cluster <cluster>

Display Kubernetes cluster details.

ibmcloud ks worker ls --cluster <cluster>

List worker nodes in a cluster.

ibmcloud ks worker-reboot --cluster <cluster> --worker <worker>

Reboot a Kubernetes worker node.

ibmcloud ks worker-rm --cluster <cluster> --worker <worker>

Remove a worker node.

ibmcloud ks cluster config --cluster <cluster>

Configure kubectl access to a Kubernetes cluster.

IBM Cloud Code Engine

ibmcloud plugin install code-engine

Install the IBM Cloud Code Engine CLI plugin.

ibmcloud ce project list

List Code Engine projects.

ibmcloud ce project create --name <project>

Create a Code Engine project.

ibmcloud ce project select --name <project>

Select a Code Engine project.

ibmcloud ce app list

List Code Engine applications.

ibmcloud ce app create --name <app> --image <image>

Create a Code Engine application from a container image.

ibmcloud ce app get --name <app>

Display Code Engine application details.

ibmcloud ce app delete --name <app>

Delete a Code Engine application.

ibmcloud ce job list

List Code Engine jobs.

IBM Cloud Container Registry

ibmcloud cr login

Authenticate Docker with IBM Cloud Container Registry.

ibmcloud cr namespaces

List Container Registry namespaces.

ibmcloud cr namespace-add <namespace>

Create a Container Registry namespace.

ibmcloud cr images

List container images.

ibmcloud cr image-inspect <image>

Inspect a container image.

ibmcloud cr image-rm <image>

Delete a container image.

ibmcloud cr image-prune

Remove unused container images.

IBM Cloud Functions

ibmcloud plugin install cloud-functions

Install the IBM Cloud Functions CLI plugin.

ibmcloud fn namespace list

List Cloud Functions namespaces.

ibmcloud fn action list

List Cloud Functions actions.

ibmcloud fn action create <name> <file>

Create a Cloud Functions action.

ibmcloud fn action invoke <name>

Invoke a Cloud Functions action.

ibmcloud fn action delete <name>

Delete a Cloud Functions action.

IBM Cloud Databases

ibmcloud resource service-instances

List provisioned IBM Cloud database service instances.

ibmcloud resource service-instance <name>

Display database service instance details.

ibmcloud resource service-keys <service_instance>

List service credentials for a database service.

ibmcloud resource service-key-create <name> <service_instance>

Create credentials for a service instance.

IBM Cloud Monitoring

ibmcloud resource service-instances

List IBM Cloud monitoring service instances.

ibmcloud resource service-instance <name>

Inspect a monitoring service instance.

ibmcloud resource service-bindings <service_instance>

List bindings associated with a monitoring service.

IBM Cloud Secrets Manager

ibmcloud plugin install secrets-manager

Install the IBM Cloud Secrets Manager CLI plugin.

ibmcloud secrets-manager secret-list

List secrets available through Secrets Manager.

ibmcloud secrets-manager secret

Display information about a secret.

IBM Cloud Resource Controller

ibmcloud resource service-instances

List service instances managed by IBM Cloud Resource Controller.

ibmcloud resource service-instance-create <name> <service> <plan> <location>

Create a service instance.

ibmcloud resource service-instance-delete <name>

Delete a service instance.

ibmcloud resource service-aliases

List service aliases.

IBM Cloud DevOps Workflow

ibmcloud login --apikey <api_key>

Authenticate CI/CD jobs using an IBM Cloud API key.

ibmcloud target -r <region>

Select the IBM Cloud region used by the pipeline.

ibmcloud target -g <resource_group>

Select the resource group used by the pipeline.

ibmcloud cr login

Authenticate Docker with IBM Cloud Container Registry.

docker build -t <image>:<tag> .

Build a container image for an IBM Cloud deployment.

docker push <registry>/<namespace>/<image>:<tag>

Push the image to IBM Cloud Container Registry.

ibmcloud ce app update --name <app> --image <image>

Deploy an updated container image to Code Engine.

IBM Cloud CLI Output and Troubleshooting

ibmcloud help

Display general CLI help.

ibmcloud <command> --help

Display help for a specific command.

ibmcloud plugin list

Check installed plugin versions and availability of updates.

ibmcloud target

Verify the currently targeted account, region and resource group.

ibmcloud logout

Clear the current login session before authenticating again.

ibmcloud login --sso

Use SSO authentication when a federated identity is required.

Useful IBM Cloud DevOps Commands

ibmcloud -v

Check the IBM Cloud CLI version before troubleshooting.

ibmcloud plugin list

Check installed service plugins.

ibmcloud target

Verify the current deployment target.

ibmcloud resource service-instances

Inspect deployed cloud service instances.

ibmcloud is instances

Inspect VPC compute instances.

ibmcloud ks clusters

Inspect IBM Cloud Kubernetes clusters.

ibmcloud ce app list

Inspect Code Engine applications.

ibmcloud cr images

Inspect container images.

IBM Cloud CLI Setup and Version

ibmcloud -v

Display the installed IBM Cloud CLI version.

ibmcloud help

Display IBM Cloud CLI help and available commands.

ibmcloud update

Update the IBM Cloud CLI to the latest version.

ibmcloud config --list

Display current IBM Cloud CLI configuration.

IBM Cloud Login and Authentication

ibmcloud login

Log in to IBM Cloud interactively.

ibmcloud login --sso

Log in using a federated IBM Cloud identity.

ibmcloud login --apikey <api_key>

Log in using an IBM Cloud API key.

ibmcloud logout

Log out from the current IBM Cloud session.

ibmcloud target

Display the current targeted account, resource group and region.

ibmcloud target -r us-south

Target a specific IBM Cloud region.

ibmcloud target -g <resource_group>

Target a specific resource group.

IBM Cloud Plugins

ibmcloud plugin list

List installed IBM Cloud CLI plugins.

ibmcloud plugin repos

List configured plugin repositories.

ibmcloud plugin repo-plugins

List plugins available from configured repositories.

ibmcloud plugin install <plugin>

Install an IBM Cloud CLI plugin.

ibmcloud plugin install <plugin> -v <version>

Install a specific plugin version.

ibmcloud plugin update

Check for and update installed plugins.

ibmcloud plugin update --all

Update all available plugins.

ibmcloud plugin uninstall <plugin>

Remove an installed plugin.

ibmcloud plugin show <plugin>

Show details about an installed plugin.

IBM Cloud Accounts and Resource Groups

ibmcloud account show

Display information about the current IBM Cloud account.

ibmcloud resource groups

List resource groups.

ibmcloud resource group

Display the current targeted resource group.

ibmcloud resource group-create <name>

Create a resource group.

ibmcloud resource group-update <name>

Update a resource group.

ibmcloud resource group-delete <name>

Delete a resource group.

IBM Cloud IAM

ibmcloud iam service-id <name>

Create a service ID.

ibmcloud iam service-ids

List service IDs.

ibmcloud iam service-id-delete <id>

Delete a service ID.

ibmcloud iam service-api-key-create <service_id> <name>

Create an API key for a service ID.

ibmcloud iam service-api-keys <service_id>

List API keys for a service ID.

ibmcloud iam api-keys

List API keys associated with the current user.

ibmcloud iam user-policies <user>

List IAM policies for a user.

IBM Cloud Resources

ibmcloud resource service-instances

List service instances in the targeted resource group.

ibmcloud resource service-instance <name>

Display details for a service instance.

ibmcloud resource service-instance-create <name> <service> <plan> <location>

Create a service instance.

ibmcloud resource service-instance-delete <name>

Delete a service instance.

ibmcloud resource service-aliases

List service aliases.

ibmcloud resource service-bindings <service_instance>

List service bindings.

IBM Cloud Catalog

ibmcloud catalog search <keyword>

Search the IBM Cloud catalog.

ibmcloud catalog service <service>

Display details about a catalog service.

ibmcloud catalog service-marketplace <service>

Show marketplace information for a service.

IBM Cloud Object Storage

ibmcloud cos buckets

List Object Storage buckets using the COS plugin.

ibmcloud cos bucket-create --bucket <bucket_name>

Create an Object Storage bucket.

ibmcloud cos bucket-delete --bucket <bucket_name>

Delete an Object Storage bucket.

ibmcloud cos objects --bucket <bucket_name>

List objects in a bucket.

ibmcloud cos object-head --bucket <bucket_name> --key <object>

Display metadata for an object.

ibmcloud cos object-delete --bucket <bucket_name> --key <object>

Delete an object from a bucket.

IBM Cloud VPC

ibmcloud is vpcs

List IBM Cloud VPCs.

ibmcloud is vpc-create <name>

Create a VPC.

ibmcloud is vpc <id>

Display VPC details.

ibmcloud is vpc-delete <id>

Delete a VPC.

ibmcloud is subnets

List VPC subnets.

ibmcloud is subnet <id>

Display subnet details.

ibmcloud is security-groups

List VPC security groups.

ibmcloud is security-group-rules <security_group_id>

List security group rules.

IBM Cloud VPC Virtual Servers

ibmcloud is instances

List VPC virtual server instances.

ibmcloud is instance <id>

Display virtual server details.

ibmcloud is instance-create

Create a VPC virtual server instance.

ibmcloud is instance-start <id>

Start a virtual server instance.

ibmcloud is instance-stop <id>

Stop a virtual server instance.

ibmcloud is instance-reboot <id>

Reboot a virtual server instance.

ibmcloud is instance-delete <id>

Delete a virtual server instance.

IBM Cloud VPC Images and Volumes

ibmcloud is images

List available VPC images.

ibmcloud is image <id>

Display image details.

ibmcloud is volumes

List block storage volumes.

ibmcloud is volume <id>

Display volume details.

ibmcloud is volume-create <name>

Create a block storage volume.

ibmcloud is volume-delete <id>

Delete a block storage volume.

IBM Cloud Load Balancers

ibmcloud is load-balancers

List VPC load balancers.

ibmcloud is load-balancer <id>

Display load balancer details.

ibmcloud is load-balancer-create

Create a VPC load balancer.

ibmcloud is load-balancer-delete <id>

Delete a load balancer.

IBM Cloud Kubernetes Service

ibmcloud plugin install container-service

Install the IBM Cloud Kubernetes Service CLI plugin.

ibmcloud ks clusters

List IBM Cloud Kubernetes Service clusters.

ibmcloud ks cluster get --cluster <cluster>

Display Kubernetes cluster details.

ibmcloud ks worker ls --cluster <cluster>

List worker nodes in a cluster.

ibmcloud ks worker-reboot --cluster <cluster> --worker <worker>

Reboot a Kubernetes worker node.

ibmcloud ks worker-rm --cluster <cluster> --worker <worker>

Remove a worker node.

ibmcloud ks cluster config --cluster <cluster>

Configure kubectl access to a Kubernetes cluster.

IBM Cloud Code Engine

ibmcloud plugin install code-engine

Install the IBM Cloud Code Engine CLI plugin.

ibmcloud ce project list

List Code Engine projects.

ibmcloud ce project create --name <project>

Create a Code Engine project.

ibmcloud ce project select --name <project>

Select a Code Engine project.

ibmcloud ce app list

List Code Engine applications.

ibmcloud ce app create --name <app> --image <image>

Create a Code Engine application from a container image.

ibmcloud ce app get --name <app>

Display Code Engine application details.

ibmcloud ce app delete --name <app>

Delete a Code Engine application.

ibmcloud ce job list

List Code Engine jobs.

IBM Cloud Container Registry

ibmcloud cr login

Authenticate Docker with IBM Cloud Container Registry.

ibmcloud cr namespaces

List Container Registry namespaces.

ibmcloud cr namespace-add <namespace>

Create a Container Registry namespace.

ibmcloud cr images

List container images.

ibmcloud cr image-inspect <image>

Inspect a container image.

ibmcloud cr image-rm <image>

Delete a container image.

ibmcloud cr image-prune

Remove unused container images.

IBM Cloud Functions

ibmcloud plugin install cloud-functions

Install the IBM Cloud Functions CLI plugin.

ibmcloud fn namespace list

List Cloud Functions namespaces.

ibmcloud fn action list

List Cloud Functions actions.

ibmcloud fn action create <name> <file>

Create a Cloud Functions action.

ibmcloud fn action invoke <name>

Invoke a Cloud Functions action.

ibmcloud fn action delete <name>

Delete a Cloud Functions action.

IBM Cloud Databases

ibmcloud resource service-instances

List provisioned IBM Cloud database service instances.

ibmcloud resource service-instance <name>

Display database service instance details.

ibmcloud resource service-keys <service_instance>

List service credentials for a database service.

ibmcloud resource service-key-create <name> <service_instance>

Create credentials for a service instance.

IBM Cloud Monitoring

ibmcloud resource service-instances

List IBM Cloud monitoring service instances.

ibmcloud resource service-instance <name>

Inspect a monitoring service instance.

ibmcloud resource service-bindings <service_instance>

List bindings associated with a monitoring service.

IBM Cloud Secrets Manager

ibmcloud plugin install secrets-manager

Install the IBM Cloud Secrets Manager CLI plugin.

ibmcloud secrets-manager secret-list

List secrets available through Secrets Manager.

ibmcloud secrets-manager secret

Display information about a secret.

IBM Cloud Resource Controller

ibmcloud resource service-instances

List service instances managed by IBM Cloud Resource Controller.

ibmcloud resource service-instance-create <name> <service> <plan> <location>

Create a service instance.

ibmcloud resource service-instance-delete <name>

Delete a service instance.

ibmcloud resource service-aliases

List service aliases.

IBM Cloud DevOps Workflow

ibmcloud login --apikey <api_key>

Authenticate CI/CD jobs using an IBM Cloud API key.

ibmcloud target -r <region>

Select the IBM Cloud region used by the pipeline.

ibmcloud target -g <resource_group>

Select the resource group used by the pipeline.

ibmcloud cr login

Authenticate Docker with IBM Cloud Container Registry.

docker build -t <image>:<tag> .

Build a container image for an IBM Cloud deployment.

docker push <registry>/<namespace>/<image>:<tag>

Push the image to IBM Cloud Container Registry.

ibmcloud ce app update --name <app> --image <image>

Deploy an updated container image to Code Engine.

IBM Cloud CLI Output and Troubleshooting

ibmcloud help

Display general CLI help.

ibmcloud <command> --help

Display help for a specific command.

ibmcloud plugin list

Check installed plugin versions and availability of updates.

ibmcloud target

Verify the currently targeted account, region and resource group.

ibmcloud logout

Clear the current login session before authenticating again.

ibmcloud login --sso

Use SSO authentication when a federated identity is required.

Useful IBM Cloud DevOps Commands

ibmcloud -v

Check the IBM Cloud CLI version before troubleshooting.

ibmcloud plugin list

Check installed service plugins.

ibmcloud target

Verify the current deployment target.

ibmcloud resource service-instances

Inspect deployed cloud service instances.

ibmcloud is instances

Inspect VPC compute instances.

ibmcloud ks clusters

Inspect IBM Cloud Kubernetes clusters.

ibmcloud ce app list

Inspect Code Engine applications.

ibmcloud cr images

Inspect container images.

Recommended IBM Cloud CLI Workflow

ibmcloud -v
ibmcloud login --apikey <api_key>
ibmcloud target -r <region>
ibmcloud target -g <resource_group>

ibmcloud plugin list

ibmcloud cr login
docker build -t <image>:<tag> .
docker push <registry>/<namespace>/<image>:<tag>

ibmcloud ce app update --name <app> --image <image>