macOS
Intel and Apple Silicon are both supported.
Install
Section titled “Install”curl -fsSL https://rookery.cloud/install.sh | shThe script verifies the download against the release’s checksums, puts the
binary on your PATH, and offers the optional host tools. Prefer to read it
first — it is short — or install from an archive instead: see
Binary and packages.
Set it up
Section titled “Set it up”rookery onboardThis is the step that finishes the install: it resolves the two keys and explains which one matters, creates your owner account, offers any missing host tools, and reports what it could not do in a closing Still to do list.
Then start the server and open http://localhost:8080:
rookery serveThe difference from Linux
Section titled “The difference from Linux”Whether that matters depends on what you run. Agents you built yourself, doing what you asked, are not the concern. A skill you imported from someone else is.
Keeping it running
Section titled “Keeping it running”A launchd service is not yet shipped. rookery onboard says so rather than
installing a half-working one. For now, run it in a terminal, or write your own
launch agent.
This is the practical reason a Mac is better as a place to try Rookery than as the machine you leave it on. For an always-on installation, see Linux server.
Host tools
Section titled “Host tools”Rookery uses a few optional tools. rookery onboard offers to install them; to
do it by hand, with Homebrew:
brew install python3 ripgrep poppler tesseractpython3 is the one that matters — without it, the safety check on generated
agent scripts silently switches off. ripgrep speeds up knowledge base search,
poppler provides pdftotext, and tesseract reads text from images.
Check what Rookery found:
rookery healthcheckThe browser
Section titled “The browser”Reading pages that only appear once JavaScript has run — and signing in, filling
forms and clicking through a flow — needs a headless browser. It is a separate
~200 MB download, so it is optional: rookery onboard offers it, and if you
already have it, setup does not mention it at all.
rookery browser installrookery browser statusEverything else works without it; those pages just come back empty. See Browser.
Upgrading and removing
Section titled “Upgrading and removing”rookery upgraderookery uninstallupgrade fetches the latest release, verifies it, replaces the binary in place,
and reports the version actually on disk afterwards. --version v0.1.4 moves to
a named release instead.
uninstall removes the binary and leaves your data alone unless you pass
--purge, which asks you to type the data directory back before deleting it.
rookery uninstall --dry-run shows what would go without touching anything.
Reaching it from your phone
Section titled “Reaching it from your phone”By default Rookery listens on all interfaces, so other devices on your network can
reach it at http://<your-mac>:8080. macOS will ask you to allow incoming
connections the first time.
For connections that use sign-in you also need
ROOKERY_PUBLIC_URL.