Skip to content

Start typing to search the documentation.

Getting started

Install the CLI, sign in, and create your first repo.

This walkthrough takes about three minutes. You’ll install the garage CLI, sign in via your browser, and create an empty repo.

Install the CLI

npm i -g @thegarage/cli

Verify the install:

garage --version

Sign in

garage init runs the device-flow login. There is nothing to configure: an organization is created automatically when you sign up, with an opaque server-minted slug and a name derived from your display name or email (renamable later). Re-running init is idempotent — it surfaces current state without re-prompting.

garage init

The CLI prints a URL — open it in a browser, approve the request, and the CLI receives a long-lived API key automatically.

If you only want to (re-)authenticate, use garage auth login.

Create a repository

repos create takes a bare name; the repo is created in your active org.

garage repos create hello-world

Clone it

garage git clone resolves the storage remote, mints a short-lived read token, and runs git clone with the credential helper wired up.

garage git clone hello-world

Prefer to drive git yourself? garage repos get hello-world prints the storage remote URL.

Where to next