Skip to content

chore: readme for alpha getting started steps #32

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 1 commit into from
Mar 30, 2026
Merged

chore: readme for alpha getting started steps #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# cli
# Loops CLI

The official Loops CLI

> [!NOTE]
> This is pre-release, alpha software. While we're cooking up our first official release, the easiest way to get started is to build the project yourself.

## Getting Started

### Build
1. Clone this repo and cd into the directory.
1. Install Go 1.26.1 (or whatever is listed in `go.mod`)
1. Run `go build -o ./loops .` to build a `loops` binary in the current directory. You're free to move it (`./loops`) to a location in your `$PATH` if you'd like.

### Auth

The Loops CLI requires a Loops API key to use.

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

Alternatively, Loops will use the value from the `LOOPS_API_KEY` environment variable if set.

That's it! During development, consider the CLI's `--help` output as the source of truth for features and flags.