Skip to content

docs(readme): how to deploy a release, and ignore the operator wrappers #157

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
eaitbrahim merged 2 commits into from
Jul 29, 2026
Merged

docs(readme): how to deploy a release, and ignore the operator wrappers #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2ca8b
docs(readme): how to deploy a release into a deployment
eaitbrahim Jul 29, 2026
c564db7
chore: ignore operator wrapper scripts
eaitbrahim Jul 28, 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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,7 @@ com.keel.paperforward.plist
config.live-sandbox.yaml
keel-live-run.sh
com.keel.live.plist

# operator wrappers (config+db pinned) -- deployment artifacts, copied to ~/keel
keel-live
keel-paper
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,39 @@ for any live (network) commands. `.env` is git-ignored and never committed. Offl
Runtime settings (allowlist, target weights, risk caps, market data granularities, etc.) live in
`config.yaml` at the repo root — see `keel/config.py` for the schema and validation rules.

## Deploying a new version

Cutting a release is `docs/RELEASING.md`. Installing one into a deployment (e.g. `~/keel`) is four
commands, run **from the deployment directory** — every path below is relative to it:

```bash
gh release download v0.3.1 --repo CodeGateSoftware/keel --pattern '*.whl' --dir Release/
uv pip install --python .venv --find-links Release Release/keel_trader-0.3.1-py3-none-any.whl
.venv/bin/keel --version
.venv/bin/keel status
```

Substitute the version being deployed in both of the first two lines. `--find-links Release` is
what lets the single `keel_trader` wheel resolve its `keel-core` / `keel-broker-*` siblings from
that same directory — which is why step 1 downloads them all. Installing **by path** rather than
by bare name is deliberate: `keel` on PyPI is an unrelated project, so `pip install keel` fetches a
stranger's code (see `keel/version.py`).

Step 3 is the check that matters. It must report the version you just installed, bound to a
commit, from source `[release]`:

```
keel 0.3.1+deb8fa7e978d [release]
```

A build reporting `(DIRTY)` or `[checkout]` corresponds to no commit and **must not be run against
live funds**. Step 4 is a read-only snapshot — no orders, no writes — confirming the new build
opens the database and reaches the venue.

If the deployment runs on a schedule (LaunchAgents, cron), a new build takes effect on the next
cycle with nothing to restart — each cycle is a fresh process. A **long-running** process is the
exception: a `keel tui` left open keeps the build it started with until you quit and relaunch it.

## Before trading live

Read `docs/operator-runbook.md`. It lists the compliance obligations **no rail can enforce** — chiefly
Expand Down
Loading