CLI quickstart

Set up the Hive3 command-line tool (hive3) and the Hive3 agent skill on this machine, then sign me in. Documentation: https://docs.hive3.tech/developers

Ground rules:
- Do not change anything in my Hive3 account. This setup only reads.
- Never ask me for an API key and never print or open the CLI's credential file. I sign in through my own browser.
- Hive3 developer access needs a Honey Bee plan or above. If the sign-in page says a Honey Bee subscription is required, tell me and stop.
- If you cannot run shell commands (for example in a chat app), do not pretend. Give me the commands below as a numbered list to run myself, and wait for what they print.

Steps:
1. Run `node --version`. It must be v20 or newer; if it is missing or older, tell me and stop.
2. Run `npm install --global @hive3/cli@latest`.
3. Run `hive3 --version`. It must print 0.4.0 or newer; if not, tell me and stop.
4. Install the Hive3 skill for the agent you are: `hive3 skill install --agent claude` (Claude Code), `hive3 skill install --agent codex` (Codex) or `hive3 skill install --agent cursor` (Cursor). For any other agent, run `hive3 skill install --dir <your skills directory>`. Tell me if I need to start a new session so the skill loads.
5. Run `hive3 login --access read --no-open`. It prints an approval URL and a one-time code, then waits. Start it in the background, or otherwise stream its output, so you can read it while it waits. Show me the URL and the code exactly as printed, ask me to open the URL, sign in, type the code and approve, and wait until the command finishes.
6. Run `hive3 whoami` and `hive3 capabilities`. Summarize for me: the account I signed in as, the scopes of the key, and which accounts it can act on.
7. Tell me this key is read only. For write access later I can ask you to run `hive3 login --access full`, which needs my approval in the browser again. Do not run it unless I ask.

The hive3 command-line tool lets you create and manage posts, events, courses, quests, jobs, broadcasts and more from a terminal or a script. This page takes you from installation to your first three commands: creating a post, searching, and listing events.

#Before you start

• Node.js 20 or newer. Check with node --version.
• A Hive3 account on Honey Bee or above. The account you sign in with when you approve the login is the account the CLI acts as.
• A web browser. It can be on another machine; you only need to open one URL and type one code.

#Install the CLI

1. Install the package

   InstallCopy

   npm install --global @hive3/cli

   The package installs the hive3 command. hive also works as a short alias for people who installed an earlier version, and runs the same program.

2. Check that it runs

   Check the version and show the command listCopy

   hive3 --version
   hive3 --help

   hive3 --version (or -v) prints the installed version. Help never needs a login. Run hive3 <command> --help (for example hive3 events --help) to see the actions and flags of one command.

#Sign in

1. Start the login

   Start browser approvalCopy

   hive3 login

   The terminal prints an approval URL and a one-time code, then tries to open your browser:

   Terminal outputCopy

   Open this URL to approve Hive CLI access: https://app.hive3.tech/cli/authorize
   Code: ABCD-EF2G (type it on the approval page)

   On a machine without a browser, run hive3 login --no-open and open the URL anywhere you are signed in to Hive3.

2. Enter the code

   On the approval page, sign in if asked. Under Enter the code, type the code from your terminal into CLI code. The URL never contains the code, so the page cannot be approved without you typing it.

3. Choose the access level and approve

   The page shows Approve login with the account you are approving as and the name of the request. Choose Read only or Full access. The page lists the Granted scopes for your choice. Select Approve login, or Cancel to refuse.

   Start with Read only unless you plan to change things. CLI sign-in and configuration lists exactly what each choice grants.

4. Return to the terminal

   When the page says Hive CLI approved, the terminal finishes:

   Terminal outputCopy

   Hive CLI authenticated as API key hive_sk_…
   Credential stored at /home/you/.config/hive/config.json.

   The key is stored in a private file on your machine and is never printed. It expires after 90 days.

To skip the choice on the page, for example in a script you supervise, preselect a bundle:

hive3 login --access read
hive3 login --access full

#Check who you are

hive3 whoami
hive3 capabilities

hive3 whoami prints the account, the scopes of your key, and every account the key can act on:

Account: Ada
Handle: @ada
Scopes: account:read, ai:read, broadcasts:read, communities:read, credentials:read, posts:read, resources:read, tickets:read
Accounts this key can act on: 2
- Ada (owner): read, write, moderate
- Design Guild (admin): read, write, moderate

hive3 capabilities prints the same accounts, one per line, without the header. You can act on your own account and on any account where you are currently owner, admin or moderator. If only your own account is listed, commands for other accounts will fail. See managed accounts.

If a command prints Not logged in. Run hive3 login first., no credential is stored yet. Run hive3 login.

#Run your first commands

#Create a post

Creating content needs Full access. With a Read only key the command fails with insufficient_scope and tells you the missing scope.

hive3 posts create --body "Hello from the Hive CLI" --visibility public

The CLI prints the new post as JSON, wrapped in a data object, including its id. To switch to Full access, run hive3 login --access full and approve again. The new key replaces the stored one; the earlier key stays valid until it expires or you revoke it in the app. See Sign out and revoke a key.

#Search (0.4+)

Search works with a Read only key.

hive3 search "design guild" --type accounts --limit 5

--type is one of all, accounts, events, courses, content, quests or jobs. Results show only what your account can see.

#List events

hive3 events list --limit 5

Lists are newest first. The response includes a page object with hasMore and nextCursor. Pass the cursor back to read the next page:

hive3 events list --limit 5 --cursor "<nextCursor>"

See pagination for the details.

#Update and uninstall

The CLI checks npm for a newer release at most once a day while you use it interactively, and prints a short notice on stderr after a command finishes. You can also check yourself:

hive3 update --check
hive3 update

hive3 update installs exactly the version it reports with npm install --global @hive3/cli@<version>. Set HIVE_NO_UPDATE_CHECK=1 to turn off the daily check.

To uninstall, sign out first so the key is revoked on the server, then remove the package:

hive3 logout
npm uninstall --global @hive3/cli

Uninstalling the package alone does not revoke the key or delete the stored credential file.

#What Honey Bee and above means

Honey Bee+ is the lowest plan that can create API keys and approve a CLI login. See Plans and pricing for the full plan comparison.

• Signing in needs the approving account to be on Honey Bee or above at the moment you approve.
• Using a key needs the key owner's account to stay on Honey Bee or above. If the plan drops, the key is kept but every request returns plan_required. The CLI prints Your Hive plan doesn't include API access: the API and CLI need Honey Bee or above. and asks you to upgrade under Settings. The same key works again once the plan is active; you do not need to sign in again.
• Other limits still apply. Paid-plan rules in the app, such as broadcast frequency or members-only content, apply to the CLI in the same way.

#Next steps