Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt

Use this file to discover all available pages before exploring further.

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 specific version to ensure a stable and predictable environment. You can find the CLI changelog in the CLI 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.10.1'

  - 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 specific version

Pinning to a specific CLI version ensures a stable and predictable environment. You will need to manually update the version to receive bug fixes and improvements. To pin to a specific version, use the version input with the exact CLI version number: 
steps:
  - uses: actions/checkout@v6

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

​
Pin a minor version

Pinning to a minor version installs the latest release within that minor version range (e.g., v0.10 installs the latest v0.10.x). This automatically picks up backwards-compatible bug fixes, but may introduce unexpected changes. 
steps:
  - uses: actions/checkout@v6

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

​
Inputs

​
version
string
Miru version of the CLI to install. Supports exact (v0.10.1) and minor (v0.10) versions. We recommend pinning to an exact version for a stable, predictable environment.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.10.1'

      - 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 May 28, 2026