Garage
LoginSign Up

Documentation

Everything you need to know about building, publishing, and using robot applications with Garage

Quick Start

Install Garage CLI
Get started with the Garage command-line tool
pip install garage-robotics

Installs the Garage CLI and all dependencies needed to discover, install, and run robot apps.

Install Your First App
Try a robot application in simulation
garage install navigation-stack
garage run navigation-stack

Downloads and runs a complete navigation stack in simulation with GUI access at localhost:6080.

Using Apps
Find, install, and run robot applications
  • • Browsing the app registry
  • • Installing apps with dependencies
  • • Running apps in simulation
  • • Managing app versions
  • • Troubleshooting common issues
Examples & Tutorials
Building Apps
Create and develop robot applications
  • • Creating new app projects
  • • Using app templates
  • • Development workflow
  • • Testing and validation
  • • Best practices and patterns
CLI Guide
Publishing Apps
Share your apps with the community
  • • Preparing apps for publishing
  • • Publishing workflow
  • • App validation and testing
  • • Managing published versions
  • • Community guidelines
Publishing Guide

CLI Reference

Core Commands

garage search
Search for apps
garage install
Install an app
garage run
Run an app
garage list
List installed apps
garage status
Check app status

Developer Commands

garage init
Create new app
garage dev
Development mode
garage validate
Validate app
garage publish
Publish app
garage login
Authenticate

API Reference

Registry API
Programmatic access to the Garage app registry

Base URL:

https://registry.garagerobotics.tech/api

App Endpoints

  • GET /v1/apps - List all apps
  • GET /v1/apps/search - Search apps
  • GET /v1/apps/{name} - Get app details
  • GET /v1/apps/{name}/download - Download app

User Endpoints

  • POST /v1/auth/register - Register user
  • POST /v1/auth/login - Login user
  • GET /v1/auth/me - Get current user
  • GET /v1/apps/my - Get user's apps

Community & Support

GitHub Repository
Source code and issue tracking
View on GitHub
Community Forum
Get help and share knowledge
Join Community
Example Apps
Sample applications to get started
Browse Examples