# actions-ibmcloud-cli

**Repository Path**: mirrors_ibm/actions-ibmcloud-cli

## Basic Information

- **Project Name**: actions-ibmcloud-cli
- **Description**: IBM Cloud CLI Action and setup
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# IBM Cloud CLI action

This action installs the IBM Cloud CLI and authenticates with IBM Cloud so you can run commands against it.

[![GitHub Release](https://img.shields.io/github/v/release/IBM/actions-ibmcloud-cli)](https://github.com/IBM/actions-ibmcloud-cli/releases)
[![Test](https://github.com/IBM/actions-ibmcloud-cli/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/IBM/actions-ibmcloud-cli/actions/workflows/test.yml?query=branch%3Amaster)

## Usage

### Example

```yaml
steps:
- name: Set up ibmcloud CLI
  uses: IBM/actions-ibmcloud-cli@v1
  with:
    api_key: ${{ secrets.IBMCLOUD_API_KEY }}
    region: us-south
    group: default
    plugins: container-service, secrets-manager
- name: Run an ibmcloud CLI command
  run: ibmcloud --version
```

### Inputs

- `api_key`: (optional) API Key to login to IBM Cloud obtained from your [IAM settings](https://cloud.ibm.com/iam/apikeys).

  If not provided, no attempt will be made to login in and you will need to login with the IBM Cloud CLI directly in a subsequent step.

- `region`: (optional - default: `us-south`) Region to access on IBM Cloud.

- `group`: (optional) Resource group to access on IBM Cloud.

  If not provided, the default resource group will be detected and targeted. To skip the detection of the default resource group, set this to `false`.

- `api`: (optional - default: `https://cloud.ibm.com`) API endpoint to IBM Cloud.

- `plugins`: (optional) A comma, space, or newline separated list of CLI plugins to be installed.

  The plugins can listed by name (e.g. `container-service`) or with a specific version (e.g. `container-service@0.4.102`).

  For more information about plugins see [Extending IBM Cloud CLI with plug-ins](https://cloud.ibm.com/docs/cli?topic=cli-plug-ins).

  Examples:

  ```yaml
  plugins: container-service@0.4.102, secrets-manager

  plugins: container-service@0.4.102 secrets-manager

  plugins: |
    container-service@0.4.102
    secrets-manager
  ```

### Outputs

- `version`: The version of the IBM Cloud CLI that was installed.

  This can be accessed in a subsequent step by accessing the outputs as follows:

  ```yaml
  steps:
  - name: Set up ibmcloud CLI
    id: ibmcloud
    uses: IBM/actions-ibmcloud-cli@v1
  - run: ibmcloud --version
         # => ibmcloud 2.31.0 (6b1eddc-2024-12-05T17:30:20+00:00)
  - run: echo The version installed is ${{ steps.ibmcloud.outputs.version }}
         # => The version installed is 2.31.0
  ```

### Supported Platforms

The action works on these [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) images. Runner images not listed below are not supported yet.

| OS      | Supported        |
| ------- | ---------------- |
| Ubuntu  | `ubuntu-24.04` (`ubuntu-latest`), `ubuntu-24.04-arm`, `ubuntu-24.04-ppc64le`, `ubuntu-24.04-s390x`, `ubuntu-22.04`, `ubuntu-22.04-arm` |
| macOS   | `macos-26`, `macos-15` (`macos-latest`), `macos-14` |
| Windows | `windows-2025` (`windows-latest`), `windows-2022` |

## Versioning

The v2 major version updates the GitHub Actions required runtime to Node.js 24. GitHub-hosted runners already include this, but self-hosted runners may need to be updated ahead of planned deprecations of Node 20 on GitHub Actions runners.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

The action is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).