loadout-ai 0.9.1 → 0.9.3

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.
@@ -0,0 +1,135 @@
1
+ # README and unified hero design
2
+
3
+ ## Goal
4
+
5
+ Make Loadout understandable to a first-time visitor in under 30 seconds, give
6
+ that visitor a safe first success in under five minutes, and provide one
7
+ shareable product image that explains the complete workflow.
8
+
9
+ The target reader is a developer who uses at least one AI coding agent and may
10
+ use Claude Code and Codex together. The README should assume no knowledge of
11
+ Loadout's internal terminology.
12
+
13
+ ## Reference lessons
14
+
15
+ - [Graphify](https://github.com/Graphify-Labs/graphify) leads with one concrete
16
+ outcome, reaches the install command immediately, shows what the command
17
+ produces, and moves detail below the first success.
18
+ - [Wander Agent](https://github.com/VirajMishra1/wander-agent) uses plain
19
+ language, copyable examples, visible outcomes, and setup paths organized by
20
+ the tool the reader already uses.
21
+
22
+ Loadout will adopt those information-design principles without copying their
23
+ text or structure verbatim.
24
+
25
+ ## Unified hero image
26
+
27
+ Create one 16:9, white-background, hand-drawn infographic in the visual style
28
+ of the two current product diagrams. It must remain legible when rendered at
29
+ 960 pixels wide on GitHub and when used as an X link preview.
30
+
31
+ The layout has two related lanes:
32
+
33
+ 1. The extension lifecycle: **Discover -> Curate -> Activate**.
34
+ - Discover: `skills • tools • MCP`
35
+ - Curate: `screened • pinned • reversible`
36
+ - Activate: `right tools for this repo`
37
+ - The curator skill is represented inside the Curate stage, not as a sixth
38
+ unrelated product concept.
39
+ 2. The two-agent workflow: **Claude Code <-> Loadout <-> Codex**.
40
+ - Handoff: `durable tasks + bundled context`
41
+ - Coordinate: `ownership • contracts • decisions`
42
+
43
+ Use the exact headline `YOUR TOOLS. YOUR AGENTS. ONE LOADOUT.` and the exact footer
44
+ `Preview every change • Roll back anytime • Full audit trail`.
45
+
46
+ Use restrained purple, blue, orange, and green accents with dark readable
47
+ lettering. Avoid gradients, tiny explanatory prose, fake UI screenshots,
48
+ unsupported metrics, star counts, and absolute novelty claims. The image
49
+ should communicate the combined workflow rather than claim that no related
50
+ project exists.
51
+
52
+ Generate the bitmap with the built-in image generator, inspect it for text and
53
+ layout accuracy, and save the accepted result as a new versioned asset under
54
+ `docs/assets/`. Preserve the existing two images as historical assets unless a
55
+ later cleanup explicitly removes them.
56
+
57
+ ## README information architecture
58
+
59
+ The README is a tutorial-first front page with reference material below it.
60
+ Use this order:
61
+
62
+ 1. Centered project name, the truthful value proposition **Manage skills for
63
+ 12 coding agents. Hand off and coordinate work between Claude Code and
64
+ Codex.**, badges, and the unified hero.
65
+ 2. **Try it in 30 seconds**: install Loadout, preview the Stable loadout, and
66
+ explain that the preview command changes no agent files. Do not imply that
67
+ the preceding global npm installation changes nothing.
68
+ 3. **What Loadout does**: five short capabilities—discover, curate, activate,
69
+ handoff, coordinate—with one outcome each.
70
+ 4. **Use Claude Code and Codex together**: a minimal handoff example followed
71
+ by a minimal coordination example. State clearly that this is structured
72
+ shared project state, not a merged context window or uninterrupted model
73
+ conversation.
74
+ 5. **Try these prompts**: plain-language requests a user can paste into an
75
+ agent after installing the curator and handoff skills.
76
+ 6. **Install and choose your agent**: the recommended npm installation first,
77
+ the preview and apply commands, then `loadout status` as a concrete success
78
+ check. Follow with concise agent-specific guidance and links to detailed
79
+ documentation.
80
+ 7. **Safety and trust**: preview-first behavior, pinned sources, secret-redacted
81
+ bounded bundles, snapshots, rollback, and the audit trail.
82
+ 8. **Proof and demo**: keep the clickable YouTube thumbnail because it is a
83
+ playable demonstration, not a second product explainer. Keep factual claims
84
+ tied to the existing evidence manifest and generated discovery block.
85
+ 9. **Reference**: compact command table, supported agents, profiles, and links
86
+ to full guides.
87
+ 10. **Community**: contribution, security, attribution, and license links.
88
+
89
+ The README will use only the new unified product infographic. Existing product
90
+ diagrams will no longer be embedded. The YouTube preview and small status
91
+ badges are exempt because they serve navigation and proof rather than explain
92
+ the product architecture.
93
+
94
+ ## Writing rules
95
+
96
+ - Lead with the outcome, then show the command, then explain the machinery.
97
+ - Use short sentences and familiar words.
98
+ - Keep the recommended path visible; move edge cases to linked guides.
99
+ - Prefer one realistic command block over several near-duplicates.
100
+ - Explain `handoff` and `coordinate` separately before contrasting them.
101
+ - Put the optional Loadout skill installation before natural-language prompts
102
+ that depend on those skills.
103
+ - Do not describe coordination as shared memory, a merged context window, or
104
+ agents talking continuously.
105
+ - Do not use hype words such as revolutionary, game-changing, or first-ever.
106
+ - Keep the README within the existing 425-line test budget and aim materially
107
+ below it.
108
+
109
+ ## Validation
110
+
111
+ - Update README tests to require exactly one local product explainer image and
112
+ its complete alt text while allowing the remote YouTube thumbnail and badges.
113
+ - Preserve generated README marker pairs and evidence-backed claims.
114
+ - Run the focused README test, README end-to-end journey, documented-command
115
+ check, evidence check, formatting check, and full project verification.
116
+ - Render or inspect the new hero at full size and at the README display width;
117
+ reject it if any required text is misspelled or visually cramped.
118
+ - Verify every documented command against the current CLI before publishing.
119
+
120
+ ## Out of scope
121
+
122
+ - Changing Loadout runtime behavior or the coordination protocol.
123
+ - Claiming market uniqueness or adding unverified benchmarks.
124
+ - Removing detailed guides that advanced users already rely on.
125
+ - Publishing a release or social post as part of this documentation change.
126
+
127
+ ## Two-agent review outcome
128
+
129
+ A bounded Claude Code and Codex review agreed on the central changes: unify the
130
+ product identity, move the safe preview above feature detail, remove repeated
131
+ handoff demonstrations and the abridged transcript, show five capabilities in
132
+ one compact section, and keep one explainer image. It also identified two copy
133
+ risks now resolved by this spec: do not imply universal agent compatibility,
134
+ and scope the “nothing changes” promise to the preview command rather than the
135
+ global package installation.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "loadout-ai",
3
- "version": "0.9.1",
3
+ "version": "0.9.3",
4
4
  "private": false,
5
5
  "license": "MIT",
6
6
  "description": "The package manager for AI coding agent extensions",
@@ -1,152 +0,0 @@
1
- # Loadout demo and voiceover
2
-
3
- Target length: **2:35 to 2:50**. Record the real CLI, cut fetch waits and typing, and do
4
- not show the retired dashboard. The final YouTube upload must be public.
5
-
6
- ## Before recording
7
-
8
- 1. Close terminals that show tokens, private paths you do not want public, or unrelated
9
- work. Increase terminal font size and use a window about 120 columns wide.
10
- 2. Confirm the release and product health:
11
-
12
- ```bash
13
- npm install --global loadout-ai@0.9.0
14
- hash -r
15
- loadout --version
16
- loadout health
17
- ```
18
-
19
- 3. Finish the remaining founder acceptance path before recording. Keep the useful
20
- successful output in terminal history, but start the recording from a clean prompt.
21
- 4. Rehearse the voiceover once. Use macOS Screenshot (`Shift-Command-5`) with your
22
- microphone, OBS, or another recorder. Record at normal speed; speed the final cut
23
- to 1.1x only if necessary.
24
-
25
- ## Shot list and exact narration
26
-
27
- ### 0:00 to 0:15: the problem
28
-
29
- **Screen:** README hero, then a terminal showing `loadout --version`.
30
-
31
- **Say:**
32
-
33
- > AI coding extensions are scattered across GitHub. You find a skill on X, an MCP
34
- > server on Reddit, copy it into one agent, and later have no idea where it came from
35
- > or how to undo it. I built Loadout: one local CLI to discover, inspect, install,
36
- > update, and roll back agent extensions across Codex, Claude Code, and other agents.
37
-
38
- ### 0:15 to 0:50: one safe install
39
-
40
- **Screen:** Run the preview, then apply. Cut the fetch wait, not the result.
41
-
42
- ```bash
43
- loadout setup --mode stable --agents codex,claude-code --api-access none
44
- loadout setup --mode stable --agents codex,claude-code --api-access none --yes
45
- ```
46
-
47
- **Say:**
48
-
49
- > Stable selects thirty useful skill directories per agent from four pinned public
50
- > sources. The first run is a preview: it shows the sources, targets, credentials, and
51
- > safety findings without changing agent files. When I approve it, Loadout applies one
52
- > transaction and gives me a rollback snapshot. My ChatGPT and Claude subscriptions
53
- > are not treated as API keys, and normal skill setup does not need one.
54
-
55
- ### 0:50 to 1:12: see what changed and undo it
56
-
57
- **Screen:**
58
-
59
- ```bash
60
- loadout scan
61
- loadout status
62
- loadout rollback --list
63
- loadout rollback --snapshot <stable-snapshot-id>
64
- ```
65
-
66
- **Say:**
67
-
68
- > Scan separates Loadout-managed skills from files I already had. Status keeps source
69
- > and version ownership, and rollback restores the exact pre-install snapshot while
70
- > preserving unrelated skills. I use the exact snapshot ID shown by the install, so
71
- > there is no ambiguity. Complete uninstall is available too.
72
-
73
- ### 1:12 to 1:42: broad catalog, focused project
74
-
75
- **Screen:** Show the profile choices, catalog coverage, and a real project
76
- recommendation. These commands are read-only and do not require a prepared Maximum
77
- library.
78
-
79
- ```bash
80
- loadout profiles
81
- loadout catalog --coverage
82
- loadout recommend --project . --agent codex
83
- ```
84
-
85
- **Say:**
86
-
87
- > Loadout has three useful levels. Stable installs a bounded daily set. Power is
88
- > broader. Maximum keeps a large screened library disabled instead of dumping every
89
- > skill into every prompt. For this TypeScript CLI, the project recommender proposes
90
- > tools for documentation, testing, security, and MCP work without changing anything.
91
-
92
- ### 1:42 to 2:05: MCP, tools, and custom skills
93
-
94
- **Screen:**
95
-
96
- ```bash
97
- loadout mcp-recipe --credential-free
98
- loadout mcp-recipe playwright --agent codex
99
- loadout tool graphify --agents codex,claude-code
100
- loadout install --mode custom --package humanizer --agents codex
101
- ```
102
-
103
- **Say:**
104
-
105
- > MCP servers and executable tools are never hidden inside a profile. Playwright is a
106
- > separately previewed MCP recipe; Graphify is a pinned runtime tool; and a catalog
107
- > skill such as Humanizer can be installed directly through Custom mode. Each path
108
- > discloses permissions and credentials before approval.
109
-
110
- ### 2:05 to 2:28: hand work from Claude Code to Codex
111
-
112
- **Screen:**
113
-
114
- ```bash
115
- loadout skills install loadout-handoff --yes
116
- loadout handoff codex "write tests for the auth module" --context "see src/auth.ts"
117
- loadout handoff
118
- ```
119
-
120
- **Say:**
121
-
122
- > Loadout also gives Claude Code and Codex a tiny shared handoff log. Claude can leave
123
- > a bounded task with context, and Codex sees it when the next session checks its
124
- > inbox. It is intentionally a local file workflow—not a background service or a live
125
- > chat channel.
126
-
127
- ### 2:28 to 2:48: close
128
-
129
- **Screen:** Return to the README hero and the handoff row in the workflow image.
130
-
131
- **Say:**
132
-
133
- > Loadout stays local and does not require an LLM API key to manage skills. One CLI
134
- > gives your coding agents a setup you can inspect, improve, pass work through, and
135
- > undo. Agent extensions, under control.
136
-
137
- ## Final edit and upload
138
-
139
- - Remove loading screens, typing pauses, repeated commands, notifications, and secrets.
140
- - Keep terminal output readable at 1080p; do not use a synthetic dashboard or mock data.
141
- - Add a small title card: **Loadout: Agent extensions, under control.**
142
- - Export under three minutes and upload publicly to YouTube.
143
- - Watch the uploaded video once, confirm audio and text are legible, then paste the
144
- exact public URL into the README.
145
-
146
- ## Submission checklist
147
-
148
- - [ ] Public YouTube video is under three minutes and its URL opens signed out.
149
- - [ ] Voiceover shows preview, rollback, and Claude Code ↔ Codex handoff.
150
- - [ ] Repository and npm links open in a signed-out browser.
151
- - [ ] README installation and user-test paths match the published version.
152
- - [ ] No terminal frame exposes tokens, usernames, or private repository names.