Skip to content

Commit e8cca5f

Browse files
munessMuness Castleclaude
authored
docs: clarify bespoke bottles and example-team documentation (#51)
- Add intro explaining bespoke vs curated bottles - Replace misleading "air-gapped" bullet with "team standardization" - Remove invalid JSON comments, move explanations to prose - Add manifest field explanations (tools vs plugins vs opencode_plugins) - Fix sg/superego naming consistency - Make example path explicit with placeholder - Expand Figma troubleshooting with full steps - Clarify SETUP.md audience (for AI assistants) Co-authored-by: Muness Castle <[email protected]> Co-authored-by: Claude Opus 4.5 <[email protected]>
1 parent 3fe5acd commit e8cca5f

File tree

3 files changed

+30
-13
lines changed

3 files changed

+30
-13
lines changed

bottles/example-team/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# Example Team Bottle
22

3+
This is a template for teams sharing a bottle configuration via version control. Copy this folder to your project (e.g., `dev_tools/bottle/`) and customize it.
4+
35
## Quick Start
46

57
```bash
6-
bash dev_tools/bottle/bootstrap.sh
8+
bash <your-path>/bootstrap.sh
79
```
810

11+
(Replace `<your-path>` with wherever you copied this folder, e.g., `dev_tools/bottle`)
12+
913
This runs through:
1014
1. **Bottle install** - Installs all tools from `manifest.json`
11-
2. **OpenCode integrate** - Configures plugins/MCP in project root
15+
2. **OpenCode integrate** - Configures plugins and MCP servers in your project
1216

1317
## What Gets Installed
1418

@@ -17,7 +21,7 @@ This runs through:
1721
| **opencode** | AI coding assistant |
1822
| **ba** | Task tracking - claim/finish work items |
1923
| **wm** | Working memory - context from past sessions |
20-
| **superego** | Metacognitive review - sanity check before commits |
24+
| **superego** (`sg`) | Metacognitive review - sanity check before commits |
2125
| **azure-cli** | Azure resource management |
2226
| **Figma MCP** | Design context - share Figma URLs |
2327

@@ -54,7 +58,7 @@ wm dive-prep "intent" # Prepare context
5458
wm show # Show context
5559
```
5660

57-
### Metacognitive Review (sg)
61+
### Metacognitive Review (`sg`)
5862
```bash
5963
sg review # Review before commit
6064
```
@@ -67,7 +71,9 @@ sg review # Review before commit
6771
→ Run: `bash dev_tools/bottle/bootstrap.sh`
6872

6973
**"Figma not working"**
70-
→ Set `FIGMA_API_KEY` in `~/.zshrc`
74+
→ Get an API key from https://www.figma.com/developers/api#access-tokens
75+
→ Add to `~/.zshrc`: `export FIGMA_API_KEY="your-key"`
76+
→ Run `source ~/.zshrc`
7177

7278
---
7379

bottles/example-team/SETUP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SETUP.md - Example Team
22

3-
AI assistant guidance for environment setup and troubleshooting.
3+
This file is for AI assistants (Claude Code, OpenCode, etc.) to read when helping with environment setup and troubleshooting.
44

55
## Environment Check
66

@@ -67,7 +67,7 @@ wm dive-prep "intent" # Prepare context for session
6767
wm show # Show current context
6868
```
6969

70-
### Metacognitive Review (sg)
70+
### Metacognitive Review (`sg`)
7171
```bash
7272
sg review # Review before commit
7373
```

docs/bespoke.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Bespoke Bottles
22

3-
Bespoke bottles let you create custom tool configurations with pinned versions, independent of curated bottle updates.
3+
While `stable` and `edge` bottles are curated by Open Horizon Labs and update automatically, a bespoke bottle is one you create and maintain yourself. You control exactly which tools and versions it contains.
44

55
## When to Use Bespoke Bottles
66

77
- **Version pinning**: Lock specific versions you've tested together
88
- **Custom tool sets**: Include only the tools you need
99
- **Experimentation**: Test new versions before they hit stable
10-
- **Offline/air-gapped**: Pre-configure manifests for environments without internet
10+
- **Full ownership**: Define and maintain your own toolstack, independent of upstream releases
1111

1212
## Creating a Bespoke Bottle
1313

@@ -64,16 +64,24 @@ This copies the current stable manifest as your starting point:
6464
}
6565
```
6666

67+
**Manifest fields:**
68+
- `tools`: CLI tools to install (e.g., `ba`, `wm`). These are the actual binaries.
69+
- `plugins`: Claude Code plugins to configure. Often matches your tools list.
70+
- `opencode_plugins`: OpenCode-specific plugins (separate from Claude Code).
71+
- `prerequisites`: Dependencies users need before installing (informational).
72+
6773
## Editing the Manifest
6874

6975
Edit `~/.bottle/bottles/mystack/manifest.json` to customize:
7076

7177
### Pin a Specific Version
7278

79+
Pin `wm` to an older version you've tested:
80+
7381
```json
7482
{
7583
"tools": {
76-
"wm": "0.2.2", // Pin to older version
84+
"wm": "0.2.2",
7785
"ba": "0.2.1",
7886
"superego": "0.9.0"
7987
}
@@ -82,26 +90,29 @@ Edit `~/.bottle/bottles/mystack/manifest.json` to customize:
8290

8391
### Remove Tools You Don't Need
8492

93+
Remove `wm` and `oh-mcp` by omitting them from `tools`, and update the `plugins` list to match:
94+
8595
```json
8696
{
8797
"tools": {
8898
"ba": "0.2.1",
8999
"superego": "0.9.0"
90-
// Removed wm and oh-mcp
91100
},
92-
"plugins": ["ba", "superego"] // Update plugins list too
101+
"plugins": ["ba", "superego"]
93102
}
94103
```
95104

96105
### Add a Tool Not in Stable
97106

107+
Add `datasphere` to your tool set:
108+
98109
```json
99110
{
100111
"tools": {
101112
"ba": "0.2.1",
102113
"wm": "0.3.1",
103114
"superego": "0.9.0",
104-
"datasphere": "0.1.0" // Added datasphere
115+
"datasphere": "0.1.0"
105116
},
106117
"plugins": ["ba", "superego", "wm", "datasphere"]
107118
}

0 commit comments

Comments
 (0)