Skip to main content
Framed content
Miru provides an official action for installing the Miru CLI. You can find it on GitHub at mirurobotics/setup-cli.

​
Usage

Since the CLI is still in beta, we highly recommend pinning to a minor version to avoid breaking changes. Changes within a minor version are guaranteed to be backwards compatible. You can find the CLI changelog in the developer changelog.

​
Basic usage

After installing the Miru CLI, specify the MIRU_API_KEY environment variable to authenticate the CLI. Then, run any CLI commands you need to perform. 
steps:
  - uses: actions/checkout@v6

  - name: Setup Miru CLI
    uses: mirurobotics/setup-cli@v0.2
    with:
      version: 'v0.9'

  - name: Run your CI task here
    env:
      MIRU_API_KEY: ${{ secrets.MIRU_API_KEY }}
    run: |
      # simply prints out the version of the CLI
      miru version

​
Pin a minor version

Pinning to a minor version of the CLI will install the latest release within that minor version range. For example, pinning to CLI version v0.9 will install the latest v0.9.x release. This is the recommended approach to receive the latest bug fixes and improvements while avoiding breaking changes. 
steps:
  - uses: actions/checkout@v6

  - name: Setup Miru CLI (latest v0.9.x)
    uses: mirurobotics/setup-cli@v0.2
    with:
      version: 'v0.9'

​
Pin a specific version

Although not recommended, you can pin to a specific version to ensure a stable and predictable environment. However, you won’t receive the latest bug fixes and improvements unless you manually upgrade the CLI. 
steps:
  - uses: actions/checkout@v6

  - name: Setup Miru CLI
    uses: mirurobotics/setup-cli@v0.2
    with:
      version: 'v0.9.1'

​
Inputs

​
version
string
Miru version of the CLI to install. Supports exact (v0.9.1) and minor (v0.9) versions. We recommend using a minor version to avoid breaking changes.Omit or use latest for the most recent release. However, this is not recommended as it may introduce breaking changes.

​
Outputs

​
version
string
required
The version of the Miru CLI that was installed.

​
Supported Platforms

This action supports the following runner environments:
OSArchitecture
Linuxx86_64, arm64
Windows and macOS runners are not currently supported.

​
Example

​
Create a release

The following GitHub Actions workflow creates a release when a tag is pushed to the repository. To use the workflow, place it in the .github/workflows directory of your repository (e.g., .github/workflows/create-miru-release.yml).
.github/workflows/create-miru-release.yml
name: Create Miru Release

on:
  push:
    tags: 
      - '*'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Setup Miru CLI
        uses: mirurobotics/setup-cli@v0.2
        with:
          version: 'v0.9'

      - name: Create the release
        env:
          MIRU_API_KEY: ${{ secrets.MIRU_API_KEY }}
        run: |
          miru release create \
            --version "${{ github.ref_name }}" \
            --schemas ./schemas
CLI command The --version flag is used to specify the release’s version, which is the tag pushed to the repository in this example. The --schemas flag is used to specify the directory containing the schemas to include in the release. For a comprehensive guide on creating releases, visit the create releases documentation. For a concise reference of the CLI command, visit the CLI Reference. API key scopes The API key scopes required to create a release are listed in the create release command’s API key scopes section.
Last modified on February 12, 2026