whale-igniter 1.3.6 → 1.3.7
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 +102 -81
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,132 +9,151 @@
|
|
|
9
9
|
<img alt="local first" src="https://img.shields.io/badge/local--first-agent%20memory-%230034D3?labelColor=%23F2ECE1&style=flat-square">
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
---
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
components, decisions, refinements and generated agent context. It is
|
|
16
|
-
CLI-first, deterministic by default, and works with Codex, Claude Code,
|
|
17
|
-
Cursor, Copilot and any MCP client.
|
|
14
|
+
**Your agent is only as smart as the context you give it. Whale makes that context automatic.**
|
|
18
15
|
|
|
19
|
-
|
|
16
|
+
AI agents — Claude Code, Codex, Cursor, Copilot — are powerful but amnesiac by design. Every conversation starts from zero. They don't know what you decided, why you decided it, or which exceptions are intentional. Without structure, they guess.
|
|
20
17
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
npx whale-igniter remember
|
|
25
|
-
npx whale-igniter check
|
|
26
|
-
```
|
|
18
|
+
Whale Igniter gives your repo a **living memory**: design foundations, components, decisions, and approved exceptions — kept in sync by the CLI, readable by any agent, and never dependent on a chat history that will disappear.
|
|
19
|
+
|
|
20
|
+
---
|
|
27
21
|
|
|
28
|
-
|
|
22
|
+
## How it works
|
|
29
23
|
|
|
30
24
|
```bash
|
|
31
25
|
npm install -g whale-igniter
|
|
32
26
|
whale ignite my-app
|
|
33
27
|
```
|
|
34
28
|
|
|
35
|
-
|
|
29
|
+
That single command creates a structured intelligence layer inside your project:
|
|
36
30
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
```text
|
|
31
|
+
```
|
|
40
32
|
my-app/
|
|
41
|
-
├── whale.config.json
|
|
42
|
-
├── CLAUDE.md
|
|
33
|
+
├── whale.config.json # foundations, stack, theme, AI targets
|
|
34
|
+
├── CLAUDE.md # agent-readable project brief, auto-synced
|
|
43
35
|
├── intelligence/
|
|
44
|
-
│ ├── components.json
|
|
45
|
-
│ ├── decisions.json
|
|
46
|
-
│ └── refinements.json
|
|
47
|
-
└── llm-wiki/
|
|
36
|
+
│ ├── components.json # component catalog with variants and states
|
|
37
|
+
│ ├── decisions.json # architectural decisions and their rationale
|
|
38
|
+
│ └── refinements.json # approved exceptions — "this is intentional"
|
|
39
|
+
└── llm-wiki/ # generated markdown, one file per concern
|
|
48
40
|
```
|
|
49
41
|
|
|
50
|
-
`intelligence/*.json` is the source of truth. Markdown
|
|
51
|
-
from it so agents always read current project state.
|
|
42
|
+
`intelligence/*.json` is the source of truth. Markdown is generated from it. When you run `whale sync`, everything regenerates — CLAUDE.md, the wiki, the context your agent reads on the next conversation.
|
|
52
43
|
|
|
53
|
-
|
|
44
|
+
The agent doesn't guess anymore. It reads.
|
|
54
45
|
|
|
55
|
-
|
|
46
|
+
---
|
|
56
47
|
|
|
57
|
-
|
|
48
|
+
## What agents can read — and write
|
|
58
49
|
|
|
59
|
-
|
|
50
|
+
Whale ships an **MCP server** that exposes your project intelligence as structured tools any compatible client can call:
|
|
60
51
|
|
|
61
|
-
|
|
52
|
+
```bash
|
|
53
|
+
whale mcp config --client claude-code
|
|
54
|
+
whale mcp config --client cursor
|
|
55
|
+
whale mcp config --client zed
|
|
56
|
+
```
|
|
62
57
|
|
|
63
|
-
|
|
58
|
+
| Tool | What it does |
|
|
59
|
+
|---|---|
|
|
60
|
+
| `whale_project_overview` | Full project brief: stack, foundations, packs, context |
|
|
61
|
+
| `whale_list_components` | Component catalog with files, variants, states, tokens |
|
|
62
|
+
| `whale_list_decisions` | Architectural decisions with rationale and status |
|
|
63
|
+
| `whale_list_refinements` | Approved exceptions — context for drift that's intentional |
|
|
64
|
+
| `whale_insights` | Live analysis: orphans, coverage gaps, tensions, drift |
|
|
65
|
+
| `whale_register_component` | Add a component to the catalog |
|
|
66
|
+
| `whale_record_decision` | Log an architectural decision |
|
|
67
|
+
| `whale_record_refinement` | Mark a drift exception as approved |
|
|
64
68
|
|
|
65
|
-
|
|
69
|
+
Agents don't just read context — they can write back to it.
|
|
66
70
|
|
|
67
|
-
|
|
68
|
-
| --- | --- |
|
|
69
|
-
| `whale ignite my-app` | Create a new Whale workspace |
|
|
70
|
-
| `whale ignite my-app --interactive` | Wizard: project type, stack, team size, packs |
|
|
71
|
-
| `whale adopt` | Scan an existing React/Tailwind project |
|
|
72
|
-
| `whale remember` | Regenerate agent context and wiki |
|
|
73
|
-
| `whale check` | Run validation and project insights |
|
|
74
|
-
| `whale improve` | Ask Selene for improvement suggestions |
|
|
75
|
-
| `whale explain` | Generate docs and AI-readable context |
|
|
76
|
-
| `whale references add --all` | Install UI component reference library |
|
|
77
|
-
| `whale insights drift spacing` | Find off-grid spacing across CSS and JSX |
|
|
78
|
-
| `whale insights drift spacing --review` | Interactively accept or queue each drift issue |
|
|
79
|
-
| `whale changes --since HEAD~5` | Show what changed in intelligence stores |
|
|
80
|
-
| `whale team` | See active operating roles/packs |
|
|
81
|
-
| `whale create component Hero` | Generate a typed React component |
|
|
82
|
-
| `whale mcp config --client cursor` | Configure an MCP client |
|
|
71
|
+
---
|
|
83
72
|
|
|
84
|
-
##
|
|
73
|
+
## Design intelligence
|
|
85
74
|
|
|
86
|
-
Whale
|
|
75
|
+
Whale tracks your design system and detects when reality drifts from it.
|
|
87
76
|
|
|
88
77
|
```bash
|
|
89
|
-
whale
|
|
90
|
-
whale
|
|
91
|
-
whale
|
|
92
|
-
whale
|
|
93
|
-
whale team add selene # AI suggestions and audits
|
|
78
|
+
whale insights drift spacing # find off-grid spacing in CSS, JSX, Vue, Svelte
|
|
79
|
+
whale insights drift color # find raw hex values outside your token set
|
|
80
|
+
whale insights drift radii # find radius values not in your foundations
|
|
81
|
+
whale insights drift spacing --review # interactively accept or queue each issue
|
|
94
82
|
```
|
|
95
83
|
|
|
96
|
-
|
|
97
|
-
roles and instructions that help the agent you already use work with
|
|
98
|
-
better context.
|
|
84
|
+
When something drifts intentionally — a one-off exception, a product decision — you record it as a refinement. Whale stops flagging it. The agent knows it's approved.
|
|
99
85
|
|
|
100
|
-
|
|
86
|
+
---
|
|
101
87
|
|
|
102
|
-
|
|
103
|
-
|
|
88
|
+
## Theme engine
|
|
89
|
+
|
|
90
|
+
Landing pages and generated UI are fully theme-driven. No hardcoded tokens.
|
|
104
91
|
|
|
105
92
|
```bash
|
|
106
|
-
whale
|
|
107
|
-
whale
|
|
108
|
-
whale
|
|
93
|
+
whale themes list
|
|
94
|
+
whale create landing --theme harbor # royal blue on paper — the Whale brand
|
|
95
|
+
whale create landing --theme aurora # modern SaaS, indigo, generous whitespace
|
|
96
|
+
whale create landing --theme atlas # enterprise minimal, dense, neutral (default)
|
|
109
97
|
```
|
|
110
98
|
|
|
111
|
-
|
|
112
|
-
you can paste into Claude, ChatGPT, Cursor or Codex.
|
|
99
|
+
Each theme defines four tiers — Identity, Typography, Structural, Interaction — and emits a complete CSS custom property block. Swap themes; everything updates.
|
|
113
100
|
|
|
114
|
-
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Core commands
|
|
104
|
+
|
|
105
|
+
| Command | What it does |
|
|
106
|
+
|---|---|
|
|
107
|
+
| `whale ignite my-app` | Bootstrap a new Whale workspace |
|
|
108
|
+
| `whale ignite my-app --interactive` | Wizard: project type, stack, team size, packs |
|
|
109
|
+
| `whale adopt` | Scan an existing project and propose components and foundations |
|
|
110
|
+
| `whale sync` | Regenerate CLAUDE.md, wiki, and agent context |
|
|
111
|
+
| `whale check` | Validation + project insights |
|
|
112
|
+
| `whale changes --since HEAD~5` | What changed in intelligence stores since a git ref |
|
|
113
|
+
| `whale themes list` | Browse available UI themes |
|
|
114
|
+
| `whale create landing --theme <name>` | Generate a themed HTML/CSS landing page |
|
|
115
|
+
| `whale create component Hero` | Generate a typed component with intelligence registration |
|
|
116
|
+
| `whale references add --all` | Install the UI component reference library |
|
|
117
|
+
| `whale selene suggest` | AI-powered improvement suggestions (API key optional) |
|
|
118
|
+
| `whale mcp config --client cursor` | Configure an MCP client |
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
## Operating packs
|
|
123
|
+
|
|
124
|
+
Packs are structured roles — not autonomous agents, but instructions and context that help the agent you already use work with better information.
|
|
115
125
|
|
|
116
126
|
```bash
|
|
117
|
-
whale
|
|
118
|
-
whale
|
|
119
|
-
whale
|
|
127
|
+
whale team add lighthouse # quality and validation checks
|
|
128
|
+
whale team add scribe # documentation and wiki generation
|
|
129
|
+
whale team add forge # implementation architecture
|
|
130
|
+
whale team add atlas # product strategy
|
|
131
|
+
whale team add selene # AI suggestions and audits
|
|
120
132
|
```
|
|
121
133
|
|
|
122
|
-
|
|
123
|
-
validation, insights and write tools to compatible AI clients.
|
|
134
|
+
---
|
|
124
135
|
|
|
125
|
-
##
|
|
136
|
+
## AI bridge (Selene)
|
|
126
137
|
|
|
127
|
-
|
|
128
|
-
--wi-royal: #0034D3;
|
|
129
|
-
--wi-paper: #F2ECE1;
|
|
130
|
-
--wi-sky: #99CCFF;
|
|
131
|
-
--wi-deep: #003087;
|
|
138
|
+
Selene packages your project context into structured prompts. With an API key it calls the model directly; without one it prints a prompt you can paste anywhere.
|
|
132
139
|
|
|
133
|
-
|
|
134
|
-
|
|
140
|
+
```bash
|
|
141
|
+
export ANTHROPIC_API_KEY=... # or OPENAI_API_KEY
|
|
142
|
+
|
|
143
|
+
whale selene status
|
|
144
|
+
whale selene suggest --focus all
|
|
145
|
+
whale selene audit src/components/Hero.tsx
|
|
146
|
+
whale selene describe src/components/Button.tsx
|
|
135
147
|
```
|
|
136
148
|
|
|
137
|
-
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## Requirements
|
|
152
|
+
|
|
153
|
+
- Node ≥ 20
|
|
154
|
+
- No API key required for any core flow — themes, drift detection, wiki generation, and MCP are fully local and deterministic
|
|
155
|
+
|
|
156
|
+
---
|
|
138
157
|
|
|
139
158
|
## Links
|
|
140
159
|
|
|
@@ -142,6 +161,8 @@ Brand assets ship in `brand/` and are included in the npm package.
|
|
|
142
161
|
- Package: [npmjs.com/package/whale-igniter](https://www.npmjs.com/package/whale-igniter)
|
|
143
162
|
- License: MIT
|
|
144
163
|
|
|
164
|
+
---
|
|
165
|
+
|
|
145
166
|
<p align="center">
|
|
146
167
|
<img src="https://cdn.jsdelivr.net/npm/whale-igniter@1.3.0/brand/logo.svg" alt="" width="44"><br>
|
|
147
168
|
<sub><b>Whale Igniter</b> · map the project before the agent moves</sub>
|
package/dist/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const PACKAGE_VERSION = "1.3.
|
|
1
|
+
export const PACKAGE_VERSION = "1.3.7";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "whale-igniter",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.7",
|
|
4
4
|
"description": "CLI-first operational intelligence. Bootstraps and adopts AI-readable project context so agents like Claude Code, Codex and Cursor understand your design system from the first commit. Includes an MCP server, a file watcher, deterministic insights, and an opt-in AI bridge (Selene).",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|