Getting started with hive

Open the portal, read the health rail, and find your way around. Written for anyone.

#It installs with the stack

hive comes up as part of the apiary. One command installs the whole stack and brings the portal up at 127.0.0.1:3853.

macOS or Linux:

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

Windows (PowerShell):

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

#Where to look first

Go to http://127.0.0.1:3853 in your browser and bookmark it. That's the only address you need for the whole dashboard.

If the stack is still coming up, you land on the readiness screen, one tile per service. It dismisses itself the moment everything is ready and drops you into the dashboard. You never see a broken page.

#Read the health rail

A status pill for each service sits at the top of every page. The shapes read without color:

• an empty honeycomb cell means the service is starting
• a bee settling in means it just came up and is warming
• a bee with wide wings means it's active and healthy
• a one-winged bee with a caution mark means it's up but not fully healthy
• a bee on its back means it failed or is unreachable and likely needs attention

#Find your way around

The dashboard covers the whole stack:

• memories and projects
• the memory graph and the code graph
• sync activity and logs
• ROI, which nets your savings against running cost
• settings

#When a panel goes quiet

If a panel says "unreachable," the service that owns it isn't answering right now. doctor restarts crashed services on its own, and the panel recovers once the service is back. The health page shows which service, and since when, with a live log tail you can turn up or down.

#What next

• Read the common questions in the hive FAQ.
• See the commands in the command reference.
• Understand the design in How hive works.

#Common questions

Do I need to install hive separately? No. It installs with the apiary stack and comes up automatically at 127.0.0.1:3853.

What happens if I open the portal before the stack is ready? You land on a readiness screen with one tile per service. It dismisses itself and takes you to the dashboard the moment the stack is healthy.

What does a one-winged bee icon mean? That service is up but not fully healthy, a caution state short of failure. Check the health page for the specific reason.