Install the Apiary

Install the whole stack in one command, sign in, and check it is healthy. Written for anyone; no database knowledge required.

Related:

• What is the Apiary?
• How the suite fits together
• Apiary FAQ

#1. Install with one command

Paste the line for your system. You do not need Node or anything else set up first; the installer handles it.

macOS or Linux

curl -fsSL https://get.theapiary.sh | sh

Windows (PowerShell)

irm https://get.theapiary.sh/install.ps1 | iex

The installer brings up the daemons, opens the dashboard, wires up the assistants you already use, and registers the watchdog so everything survives a reboot.

Prefer to read the script first? Open get.theapiary.sh in a browser to inspect it and check the published checksums.

#2. Sign in

Open the dashboard at http://127.0.0.1:3853 and click first time setup. It shows a short code right on the page and opens a tab where you approve it, and create a free storage account if you do not have one. No copying codes out of a terminal.

#3. Check it is healthy

honeycomb status

You can also see live health for every service on the dashboard's health page.

#4. Teach it something

honeycomb remember "we deploy from the release branch, never from main"
honeycomb recall "how do we deploy"

Write it from one assistant, and a different assistant recalls it tomorrow, even on another laptop.

#5. Make your codebase searchable by meaning

nectar brood --dry-run   # preview the one-time cost
nectar brood             # describe every file once

#What runs after install

#Options

• Skip the watchdog. Add --no-doctor to manage the daemons yourself.
• Turn off usage counts. Set DO_NOT_TRACK=1. The Apiary never sends your code, prompts, memories, file paths, or names.
• Self-host the storage. Point the stack at your own Deep Lake backend; see the docs for the self-hosting guide.

#What next

• Learn the day-to-day flow in each product's own guides.
• Curious about a word? Check the Glossary.