Skip to content

docs: readme #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
notnmeyer merged 4 commits into from
Apr 1, 2026
Merged

docs: readme #43

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f73e4ea
expand the auth stuff
notnmeyer Apr 1, 2026
2f8e33d
improve the installation section
notnmeyer Apr 1, 2026
b41bf3d
flesh out the intro
notnmeyer Apr 1, 2026
7cdbd47
basic usage section
notnmeyer Apr 1, 2026
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
43 changes: 27 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# Loops CLI

The official Loops CLI
Manage your [Loops](https://loops.so) account from the terminal — send transactional emails, manage contacts, events, mailing lists, and more.

> [!NOTE]
> This is pre-release, alpha software. While we're cooking up our first official release there may be breaking changes and other bugs.

## Usage

```
loops [command] [flags]
```

Run `loops --help` to see available commands, or `loops [command] --help` for details on a specific command.

## Installation

### Homebrew
Expand All @@ -15,30 +23,33 @@ brew install loops-so/tap/loops

### Script

```
```bash
curl -fsSL --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/loops-so/cli/main/install.sh | bash
```

You can optionally specify the release version and installation path with positional arguments,
To install a specific version or to a custom path, append `-s -- <version> <path>` to `bash` in the command above. The default installation path is `~/.local/bin`.

```
... | bash -s -- v0.0.0
## Auth

```
The CLI requires a Loops API key. Get one from [Settings > API](https://app.loops.so/settings?page=api).

```
... | bash -s -- latest ~/.local/bin
```
### Keyring storage

Store a key with `loops auth login --name <name>`. Run this again with a different name to store keys for multiple teams.

- `loops auth use <name>` — set a stored key as the default
- `loops auth list` — list stored keys and see which is the default

## Getting Started
Use `--team <name>` on any command to pick a specific stored key.

### Auth
### Environment variable

The Loops CLI requires a Loops API key to use.
Set `LOOPS_API_KEY` to use a key directly — useful for CI or when keyring storage isn't available.

1. Grab an API key from https://app.loops.so/settings?page=api
1. `loops auth login --name name-for-your-key`
### Precedence

Alternatively, Loops will use the value from the `LOOPS_API_KEY` environment variable if set.
When multiple keys are available, the CLI resolves them in this order:

That's it! During development, consider the CLI's `--help` output as the source of truth for features and flags.
1. `LOOPS_API_KEY` env var
1. `--team` flag
1. The current default (set via `loops auth use`)