Garage CLI

Command-line interface for managing robot applications

Installation

Install via pip

pip install garage-cli

Install from source

git clone https://github.com/anthropics/garage.git
cd garage/cli
pip install -e .

Verify installation

garage --version

Quick Start

First Time Setup

# Login to your account
garage login

# Configure default settings
garage config set registry https://registry.garagerobotics.tech

Basic Usage

# Search for apps
garage search navigation

# Install an app
garage install nav-stack

# Run an app
garage run nav-stack

Command Reference

Authentication

Manage your account and authentication

garage login

auth

garage logout

auth

Logout from your account

garage whoami

auth

Show current logged-in user

App Management

Install, run, and manage robot applications

garage search <query>

apps

Search for apps in the registry

Example: garage search navigation autonomous

garage install <app-name>

apps

Install an app and its dependencies

Example: garage install navigation-stack

garage run <app-name>

apps

Run an installed app

Options: --gui (launch with GUI), --sim (simulation mode)

garage list

apps

List installed apps

garage remove <app-name>

apps

Remove an installed app

Publishing

Publish and manage your own apps

garage publish

publish

Publish app from current directory

Requires: garage.yaml configuration file

garage publish <package.tar.gz>

publish

Publish a specific package file

garage pack

publish

Package current directory into .tar.gz

garage validate

publish

Validate app package before publishing

Configuration

Manage CLI settings and preferences

garage config list

config

Show current configuration

garage config set <key> <value>

config

Set a configuration value

Example: garage config set default_workspace ~/robot_apps

garage config reset

config

Reset configuration to defaults

Configuration

The CLI stores configuration in ~/.garage/config.yaml

# Default configuration
registry: "https://registry.garagerobotics.tech"
workspace: "~/garage_apps"
docker:
  auto_pull: true
  cleanup: true
ros:
  default_distro: "humble"
  workspace: "~/ros2_ws"
logging:
  level: "info"
  file: "~/.garage/logs/garage.log"

Common Workflows

Installing and Running an App

# Search for navigation apps
garage search navigation

# Install a specific app
garage install autonomous-navigation

# Run the app
garage run autonomous-navigation

# Run with GUI (if supported)
garage run autonomous-navigation --gui

Publishing Your App

# Create garage.yaml in your app directory
# (see publishing docs for format)

# Validate your app
garage validate

# Package your app
garage pack

# Publish to registry
garage publish

Need Help?

Get help with the CLI or report issues.

Publishing Guide Community Support