@keepur/hive 0.3.4 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -91
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,11 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
## Get the team running
|
|
26
|
-
|
|
27
|
-
Install [beekeeper](https://github.com/keepur/beekeeper) — the operator CLI — and let it drive the install:
|
|
23
|
+
## Install
|
|
28
24
|
|
|
29
25
|
```
|
|
30
26
|
sudo npm i -g @keepur/beekeeper
|
|
@@ -32,104 +28,38 @@ beekeeper install
|
|
|
32
28
|
beekeeper hive setup
|
|
33
29
|
```
|
|
34
30
|
|
|
35
|
-
`beekeeper hive setup`
|
|
36
|
-
|
|
37
|
-
If you'd rather drive it yourself, `npm i -g @keepur/hive && hive init` still works — see [Getting started](docs/getting-started.md) for the manual walkthrough.
|
|
38
|
-
|
|
39
|
-
## What you actually get
|
|
31
|
+
That's it. `beekeeper hive setup` opens a Claude Code session that walks you through installing dependencies (Node, MongoDB, Ollama, Qdrant), running `hive init`, pairing Slack, and your first conversation. Budget about 20 minutes. The session can answer questions, tail logs, and debug in real time.
|
|
40
32
|
|
|
41
|
-
|
|
42
|
-
- **They actually remember.** Each one keeps notes on customers, projects, and decisions. They don't ask the same question twice. They don't lose context between Monday and Friday.
|
|
43
|
-
- **They run on schedule.** Morning briefing? Done. Friday pipeline summary? Sent. End-of-day open-loop sweep? Already in your inbox. They turn *"I should remember to do this"* into *"it just shows up."*
|
|
44
|
-
- **They find what was said.** *"What did Corey decide about the Smith deal?"* — answered in seconds, not by you scrolling through a month of Slack threads.
|
|
45
|
-
- **You approve risky things.** Customer emails, deal commitments, irreversible changes — they draft, you approve. Read-first, approve-first. Always, by default.
|
|
33
|
+
If something breaks during install, ask the session — it has the source repo (this one) in scope and knows the troubleshooting docs by heart.
|
|
46
34
|
|
|
47
|
-
##
|
|
35
|
+
## What you get
|
|
48
36
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
| **04 — Make one workflow reliable** | When one specific thing is worth getting right — sales follow-up, customer onboarding, ops briefings — we sit with you and shape the agents until that loop runs without you watching. |
|
|
37
|
+
- **Coworkers in Slack.** Named teammates with their own channels and DMs.
|
|
38
|
+
- **They remember.** Notes on customers, projects, decisions — they don't ask the same question twice.
|
|
39
|
+
- **They run on schedule.** Morning briefings, weekly summaries, end-of-day open-loop sweeps.
|
|
40
|
+
- **They find what was said.** *"What did Corey decide about the Smith deal?"* — answered in seconds.
|
|
41
|
+
- **You approve risky things.** Outbound emails, deal commitments — they draft, you approve. Read-first, approve-first.
|
|
55
42
|
|
|
56
43
|
## Trust posture
|
|
57
44
|
|
|
58
|
-
- **
|
|
59
|
-
- **Your data, your machine
|
|
60
|
-
- **
|
|
61
|
-
- **Customer-facing things wait for you.** Outbound emails, deal commitments, anything that can't be undone — agents draft, then ask. Read-first, approve-first — by default, not by reminder.
|
|
62
|
-
|
|
63
|
-
## Upgrading from 0.1.x
|
|
64
|
-
|
|
65
|
-
Hive 0.2.0 shipped a new instance directory layout (engine in `<instance>/.hive/`; config, logs, agent data stay at the root). Existing 0.1.x installs need a one-shot migration:
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
curl -fsSL https://raw.githubusercontent.com/keepur/hive/main/install/migrate-0.2.sh \
|
|
69
|
-
| bash -s -- ~/services/hive/<your-instance>
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Dry-run first (`--dry-run` before the instance path) to preview the file classification. Full walkthrough: [Migrating to 0.2.0](docs/migrating-to-0.2.md). Downtime is ~5 minutes per instance; the script auto-rolls-back on health-check failure.
|
|
73
|
-
|
|
74
|
-
## Updating
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
npm i -g @keepur/hive@latest
|
|
78
|
-
hive update
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
The order matters. `hive update` is driven by the globally-installed CLI, and an older CLI sometimes can't drive a newer engine layout. Refreshing the CLI first sidesteps that.
|
|
82
|
-
|
|
83
|
-
If an update doesn't go cleanly, `hive doctor` will tell you what state the install is in, and `hive rollback` swaps back to the previous engine.
|
|
84
|
-
|
|
85
|
-
## Documentation
|
|
86
|
-
|
|
87
|
-
- [Getting started](docs/getting-started.md) — install + first conversation
|
|
88
|
-
- [Managing your hive](docs/managing-your-hive.md) — plugins, skills, day-two ops
|
|
89
|
-
- [Architecture](docs/architecture.md) — what's inside the engine
|
|
90
|
-
- [Migrating to 0.2.0](docs/migrating-to-0.2.md) — for existing 0.1.x installs
|
|
91
|
-
- [Release notes — 0.2.0](docs/release-notes-0.2.0.md) — what's new, what broke
|
|
92
|
-
- [Troubleshooting](docs/troubleshooting.md) — when things break
|
|
93
|
-
|
|
94
|
-
## Requirements
|
|
95
|
-
|
|
96
|
-
- A Mac (Apple Silicon recommended)
|
|
97
|
-
- An Anthropic API key — [console.anthropic.com](https://console.anthropic.com/)
|
|
98
|
-
- Admin access to a Slack workspace
|
|
45
|
+
- **Engine is Apache-2.0.** Read the source before you run it.
|
|
46
|
+
- **Your data, your machine.** API keys live in your Mac's keychain. The language model never sees them, your customer records, or your secrets. No phone home.
|
|
47
|
+
- **Customer-facing things wait for you.** Outbound emails, deal commitments — by default, drafts that need your approval.
|
|
99
48
|
|
|
100
|
-
##
|
|
49
|
+
## What we charge for
|
|
101
50
|
|
|
102
|
-
|
|
103
|
-
hive init # Interactive setup wizard
|
|
104
|
-
hive start --daemon # Start as background service
|
|
105
|
-
hive stop # Stop the service
|
|
106
|
-
hive status # Service status
|
|
107
|
-
hive doctor [--verbose] # Health check (with fix hints)
|
|
108
|
-
hive update # Update to latest version
|
|
109
|
-
hive rollback # Roll back to previous engine
|
|
110
|
-
hive plugin add <pkg> # Install a plugin
|
|
111
|
-
hive plugin list # List installed plugins
|
|
112
|
-
hive plugin remove <name> # Remove a plugin
|
|
113
|
-
hive skill add <name> # Install a skill
|
|
114
|
-
hive skill list # List installed skills
|
|
115
|
-
hive skill upgrade # Upgrade installed skills
|
|
116
|
-
hive skill search <query> # Search registries for a skill
|
|
117
|
-
hive skill remove <name> # Remove a skill
|
|
118
|
-
hive registry add # Add a skill registry
|
|
119
|
-
hive registry list # List configured registries
|
|
120
|
-
hive registry remove # Remove a registry
|
|
121
|
-
hive credentials list # Show third-party API keys (curated)
|
|
122
|
-
hive credentials add <KEY> # Set or rotate a credential (Keychain-backed)
|
|
123
|
-
hive credentials remove <KEY> # Delete a credential
|
|
124
|
-
```
|
|
51
|
+
The shaping. The curation. Taking generic agents and turning them into a reliable operation for *your* business. The engine is open and free; you pay when you want one workflow to become rock-solid faster than you'd shape it alone.
|
|
125
52
|
|
|
126
|
-
|
|
53
|
+
Beta cohorts get the curation work free while we learn — [ask for an invite](mailto:beta@keepur.io?subject=Keepur%20beta%20invitation%20code).
|
|
127
54
|
|
|
128
|
-
|
|
55
|
+
## Docs
|
|
129
56
|
|
|
130
|
-
|
|
57
|
+
For deeper reading or when something breaks:
|
|
131
58
|
|
|
132
|
-
|
|
59
|
+
- [Architecture](docs/architecture.md) — what's inside the engine.
|
|
60
|
+
- [Managing your hive](docs/managing-your-hive.md) — plugins, skills, day-two ops.
|
|
61
|
+
- [Troubleshooting](docs/troubleshooting.md) — when things break.
|
|
62
|
+
- [Migrating to 0.2.0](docs/migrating-to-0.2.md) — for existing 0.1.x installs.
|
|
133
63
|
|
|
134
64
|
## License
|
|
135
65
|
|