Install
There are two things to install: the suli client, which talks to a Superlibrary server, and
Superlibrary itself. Most people only need the first.
Install suli
Section titled “Install suli”suli (also installed as superlibrary) is one binary. Releases are built for macOS on Apple
silicon and Intel (darwin-arm64, darwin-x64) and Linux (linux-x64, linux-arm64). The
installer needs no sudo and puts it in ~/.local/bin:
curl -fsSL https://github.com/SuperJackfruitLabs/superlibrary/releases/latest/download/install.sh | bash| Variable | Effect |
|---|---|
VERSION=v0.0.1 |
install this release tag instead of the latest |
BIN_DIR=/some/dir |
install somewhere other than ~/.local/bin |
SKILL_DIR=~/.claude/skills |
also install the agent skill there |
Pass a variable to bash, for example ... | VERSION=v0.0.1 bash.
The installer:
- refuses a download whose SHA-256 is not listed in the release’s
SHA256SUMS; - never overwrites a different program already named
suliorsuperlibrary.
Verify
Section titled “Verify”suli versionIt prints suli <version> <platform>/<arch>. A release binary reports its release tag, for
example v0.0.1; a build from source reports dev.
Sign in
Section titled “Sign in”suli loginsuli finds the sign-in service from the server and runs its device flow: open the printed link
in any browser, confirm the code, and suli keeps a device credential of its own. It works over
SSH and in a cloud session. Each later command exchanges that credential for a token that lives
five minutes. suli whoami shows who you are signed in as.
Without SUPERLIBRARY_URL, suli talks to the hosted service at https://app.superlibrary.dev,
and suli login signs in through the SuperJackfruit account service. Set SUPERLIBRARY_URL to
point it at another server. See the CLI for every variable.
The agent skill
Section titled “The agent skill”suli skill prints a SKILL.md that teaches an agent to use suli; suli skill install writes
it to <dir>/superlibrary-items/SKILL.md. It is built into the binary, so it always matches the
commands of the suli that wrote it.
Running Superlibrary itself
Section titled “Running Superlibrary itself”Superlibrary is three Workers: the API, the content Worker that serves artifact bytes, and the web app. A release contains only the CLI; the server parts are run from source.
Local development
Section titled “Local development”You need Node.js and pnpm. No Cloudflare account and no sign-in are needed: the local stack runs on Wrangler’s local emulation, with development auth.
pnpm installnode scripts/dev-keys.mjspnpm --filter @superlibrary/api dev # API on :8787pnpm --filter @superlibrary/content dev # content Worker on :8788pnpm --filter @superlibrary/web dev # web app on :5173Open http://localhost:5173.
To run the tests:
pnpm typecheck && pnpm testpnpm --filter @superlibrary/web e2e # Chromium and WebKitA deployment
Section titled “A deployment”The secrets a deployment sets are listed in Retention and operations.