Skip to content

docs: add CLI tools documentation #104

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
AbdulmujibOladayo merged 1 commit into from
Sep 11, 2026
+35 −0
Merged

docs: add CLI tools documentation #104

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
35 changes: 35 additions & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CLI Tools

PayStream ships two binaries under `cmd/`.

## paystream-api

Serves the HTTP API.

```bash
go run ./cmd/paystream-api
```

- Listens on `:8080` (configurable via `API_PORT`, see [configuration](configuration.md)).
- `GET /health` — liveness check, backed by `internal/health`.
- `GET /version` — returns `{"version": "0.1.0"}` as JSON.

## paystream-worker

Runs background jobs (Horizon polling, signing queue, webhook delivery).

```bash
go run ./cmd/paystream-worker
```

- Logs a startup timestamp and blocks, processing jobs as they're wired in.
- Intended to run as a long-lived process alongside `paystream-api`.

## Building binaries

```bash
go build -o bin/paystream-api ./cmd/paystream-api
go build -o bin/paystream-worker ./cmd/paystream-worker
```

See [CONTRIBUTING.md](../CONTRIBUTING.md) for the full development workflow.
Loading