Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ irm https://get.simtabi.com/install.ps1 | iex
## Table of contents

- [Why this exists](#why-this-exists)
- [Quick start](#quick-start)
- [Quick start](#quick-start-guide-and-usage)
- [What ships in the box](#what-ships-in-the-box)
- [URL layout at `get.simtabi.com`](#url-layout-at-getsimtabicom)
- [Project layout](#project-layout)
Expand Down Expand Up @@ -65,7 +65,18 @@ gold-standard one-liner), `Homebrew` (prompt-before-privileged-step),
`Docker get.docker.com` (distribution-aware), `uv` install (Python
bootstrap fallback), `k3s` (service installer).

## Quick start
## Quick start guide and usage

### Getting started

1. Point the CLI at a registry. Without `--registry`, it searches
`$GET_INSTALLER_REGISTRY`, `./registry.json`, and parent dirs.
2. For an HTTPS registry that needs auth, set `$GET_INSTALLER_TOKEN`
(or pass `--auth-token`); it is sent as `Authorization: Bearer <token>`.
3. Optional: keep those variables in a `KEY=VALUE` file. The CLI loads
`--env-file`, else `$GET_INSTALLER_ENV_FILE`, else `./.env` if present.

### Usage

```bash
get-installer --list # see what's available
Expand Down
Loading