@agent-native/core 0.42.0 → 0.43.0
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 +17 -56
- package/dist/cli/recap.d.ts.map +1 -1
- package/dist/cli/recap.js +24 -13
- package/dist/cli/recap.js.map +1 -1
- package/dist/cli/skills.d.ts +2 -6
- package/dist/cli/skills.d.ts.map +1 -1
- package/dist/cli/skills.js +8 -66
- package/dist/cli/skills.js.map +1 -1
- package/dist/client/blocks/index.d.ts +11 -0
- package/dist/client/blocks/index.d.ts.map +1 -1
- package/dist/client/blocks/index.js +11 -0
- package/dist/client/blocks/index.js.map +1 -1
- package/dist/client/blocks/library/AnnotatedCodeBlock.d.ts.map +1 -1
- package/dist/client/blocks/library/AnnotatedCodeBlock.js +2 -2
- package/dist/client/blocks/library/AnnotatedCodeBlock.js.map +1 -1
- package/dist/client/blocks/library/DiffBlock.d.ts.map +1 -1
- package/dist/client/blocks/library/DiffBlock.js +86 -21
- package/dist/client/blocks/library/DiffBlock.js.map +1 -1
- package/dist/client/blocks/library/FileTreeBlock.d.ts.map +1 -1
- package/dist/client/blocks/library/FileTreeBlock.js +27 -4
- package/dist/client/blocks/library/FileTreeBlock.js.map +1 -1
- package/dist/client/blocks/library/JsonExplorerBlock.js +1 -1
- package/dist/client/blocks/library/JsonExplorerBlock.js.map +1 -1
- package/dist/client/blocks/library/MermaidBlock.js +1 -1
- package/dist/client/blocks/library/MermaidBlock.js.map +1 -1
- package/dist/client/blocks/library/annotation-rail.d.ts +19 -0
- package/dist/client/blocks/library/annotation-rail.d.ts.map +1 -1
- package/dist/client/blocks/library/annotation-rail.js +19 -0
- package/dist/client/blocks/library/annotation-rail.js.map +1 -1
- package/dist/client/blocks/library/callout.config.d.ts +29 -0
- package/dist/client/blocks/library/callout.config.d.ts.map +1 -0
- package/dist/client/blocks/library/callout.config.js +33 -0
- package/dist/client/blocks/library/callout.config.js.map +1 -0
- package/dist/client/blocks/library/callout.d.ts +20 -0
- package/dist/client/blocks/library/callout.d.ts.map +1 -0
- package/dist/client/blocks/library/callout.js +61 -0
- package/dist/client/blocks/library/callout.js.map +1 -0
- package/dist/client/blocks/library/checklist.d.ts.map +1 -1
- package/dist/client/blocks/library/checklist.js +3 -3
- package/dist/client/blocks/library/checklist.js.map +1 -1
- package/dist/client/blocks/library/decision.config.d.ts +37 -0
- package/dist/client/blocks/library/decision.config.d.ts.map +1 -0
- package/dist/client/blocks/library/decision.config.js +32 -0
- package/dist/client/blocks/library/decision.config.js.map +1 -0
- package/dist/client/blocks/library/decision.d.ts +19 -0
- package/dist/client/blocks/library/decision.d.ts.map +1 -0
- package/dist/client/blocks/library/decision.js +119 -0
- package/dist/client/blocks/library/decision.js.map +1 -0
- package/dist/client/blocks/library/diagram.config.d.ts +64 -0
- package/dist/client/blocks/library/diagram.config.d.ts.map +1 -0
- package/dist/client/blocks/library/diagram.config.js +111 -0
- package/dist/client/blocks/library/diagram.config.js.map +1 -0
- package/dist/client/blocks/library/diagram.d.ts +16 -0
- package/dist/client/blocks/library/diagram.d.ts.map +1 -0
- package/dist/client/blocks/library/diagram.js +261 -0
- package/dist/client/blocks/library/diagram.js.map +1 -0
- package/dist/client/blocks/library/question-form.config.d.ts +69 -0
- package/dist/client/blocks/library/question-form.config.d.ts.map +1 -0
- package/dist/client/blocks/library/question-form.config.js +58 -0
- package/dist/client/blocks/library/question-form.config.js.map +1 -0
- package/dist/client/blocks/library/question-form.d.ts +20 -0
- package/dist/client/blocks/library/question-form.d.ts.map +1 -0
- package/dist/client/blocks/library/question-form.js +286 -0
- package/dist/client/blocks/library/question-form.js.map +1 -0
- package/dist/client/blocks/library/sanitize-html.d.ts +5 -0
- package/dist/client/blocks/library/sanitize-html.d.ts.map +1 -0
- package/dist/client/blocks/library/sanitize-html.js +240 -0
- package/dist/client/blocks/library/sanitize-html.js.map +1 -0
- package/dist/client/blocks/library/server-specs.d.ts.map +1 -1
- package/dist/client/blocks/library/server-specs.js +59 -0
- package/dist/client/blocks/library/server-specs.js.map +1 -1
- package/dist/client/blocks/library/specs.d.ts.map +1 -1
- package/dist/client/blocks/library/specs.js +11 -0
- package/dist/client/blocks/library/specs.js.map +1 -1
- package/dist/client/blocks/library/tabs.d.ts.map +1 -1
- package/dist/client/blocks/library/tabs.js +12 -12
- package/dist/client/blocks/library/tabs.js.map +1 -1
- package/dist/client/blocks/library/wireframe-kit.d.ts +260 -0
- package/dist/client/blocks/library/wireframe-kit.d.ts.map +1 -0
- package/dist/client/blocks/library/wireframe-kit.js +920 -0
- package/dist/client/blocks/library/wireframe-kit.js.map +1 -0
- package/dist/client/blocks/library/wireframe.config.d.ts +123 -0
- package/dist/client/blocks/library/wireframe.config.d.ts.map +1 -0
- package/dist/client/blocks/library/wireframe.config.js +294 -0
- package/dist/client/blocks/library/wireframe.config.js.map +1 -0
- package/dist/client/blocks/library/wireframe.d.ts +15 -0
- package/dist/client/blocks/library/wireframe.d.ts.map +1 -0
- package/dist/client/blocks/library/wireframe.js +206 -0
- package/dist/client/blocks/library/wireframe.js.map +1 -0
- package/dist/client/blocks/registry.d.ts +9 -0
- package/dist/client/blocks/registry.d.ts.map +1 -1
- package/dist/client/blocks/registry.js +12 -5
- package/dist/client/blocks/registry.js.map +1 -1
- package/dist/client/blocks/server.d.ts +1 -0
- package/dist/client/blocks/server.d.ts.map +1 -1
- package/dist/client/blocks/server.js +1 -0
- package/dist/client/blocks/server.js.map +1 -1
- package/dist/client/blocks/types.d.ts +8 -0
- package/dist/client/blocks/types.d.ts.map +1 -1
- package/dist/client/blocks/types.js.map +1 -1
- package/dist/client/rich-markdown-editor/DragHandle.d.ts.map +1 -1
- package/dist/client/rich-markdown-editor/DragHandle.js +77 -12
- package/dist/client/rich-markdown-editor/DragHandle.js.map +1 -1
- package/dist/styles/agent-native.css +1 -0
- package/dist/styles/blocks.css +1380 -0
- package/docs/content/plan-plugin.md +8 -8
- package/docs/content/pr-visual-recap.md +2 -2
- package/docs/content/template-plan.md +94 -17
- package/package.json +2 -1
- package/docs/content/visual-plans.md +0 -82
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Plan plugin & marketplace"
|
|
3
|
-
description: "Install the Agent-Native Plan skills (/visual-plan, /visual-recap
|
|
3
|
+
description: "Install the Agent-Native Plan skills (/visual-plan, /visual-recap) plus the hosted Plan MCP connector as a Claude Code or Codex plugin, or with the universal CLI. How updates work and whether you need to submit anything."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Plan plugin & marketplace
|
|
7
7
|
|
|
8
|
-
The Agent-Native **Plan** app ships as one installable bundle. A single install adds
|
|
8
|
+
The Agent-Native **Plan** app ships as one installable bundle. A single install adds both Plan slash-command skills **and** wires up the hosted Plan MCP connector, so the agent can generate plans and the skills can publish them straight into the Plan app.
|
|
9
9
|
|
|
10
10
|
## What you get {#what-you-get}
|
|
11
11
|
|
|
12
12
|
One install gives you:
|
|
13
13
|
|
|
14
|
-
- **
|
|
14
|
+
- **Two skills** — `/visual-plan` (the canonical entry point) and `/visual-recap`.
|
|
15
15
|
- **The Plan MCP connector** — registered against the hosted app at `https://plan.agent-native.com` (MCP endpoint `https://plan.agent-native.com/_agent-native/mcp`, server name `agent-native-plans`).
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Both skills **always publish to the hosted Plan app** — they create a plan via the MCP connector and hand you a link or inline plan to review. They never dump an inline Markdown/ASCII plan into chat as the deliverable. If a Plan tool returns `needs auth`, `Unauthorized`, or `Session terminated`, authenticate the connector (see each route below) instead of falling back to inline output.
|
|
18
18
|
|
|
19
19
|
> The plugin (`agent-native-visual-plans`) carries app id `visual-plans`, which is why the Claude Code plugin name and Codex plugin name are both `agent-native-visual-plans`. The Plan app's display name is "Agent-Native Plan".
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ There are three ways in. The **universal CLI route** is the one we recommend by
|
|
|
24
24
|
|
|
25
25
|
### Universal skill route (any MCP host) {#universal}
|
|
26
26
|
|
|
27
|
-
Works for any host — Claude Code, Codex, Cursor, Cline, Goose, ChatGPT custom MCP apps, Claude Cowork, and anything else MCP-compatible. The Agent-Native CLI installs
|
|
27
|
+
Works for any host — Claude Code, Codex, Cursor, Cline, Goose, ChatGPT custom MCP apps, Claude Cowork, and anything else MCP-compatible. The Agent-Native CLI installs both skills, registers the hosted Plan MCP connector, **and authenticates it in the same step**, so your first tool call does not hit an OAuth wall:
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
30
|
npx @agent-native/core@latest skills add visual-plan
|
|
@@ -32,7 +32,7 @@ npx @agent-native/core@latest skills add visual-plan
|
|
|
32
32
|
agent-native skills add visual-plan
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
This installs `visual-plan` plus the companion `visual-recap
|
|
35
|
+
This installs `visual-plan` plus the companion `visual-recap` skill, then registers the `agent-native-plans` connector and runs auth (OAuth prompt for hosted/account-backed sharing). Useful flags:
|
|
36
36
|
|
|
37
37
|
- `--client codex|claude-code|claude-code-cli|cowork|all` — which local agents to write the MCP config for (default `codex`).
|
|
38
38
|
- `--no-connect` — register the connector without authenticating; run `agent-native connect https://plan.agent-native.com` later.
|
|
@@ -54,7 +54,7 @@ The public `BuilderIO/agent-native` repo is itself a Claude Code plugin marketpl
|
|
|
54
54
|
/mcp # authenticate the Plan connector (one OAuth approval)
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
`/plugin install` adds
|
|
57
|
+
`/plugin install` adds both Plan skills and a **URL-only** MCP config (no secrets in the package); `/mcp` → **Authenticate** completes the OAuth handshake.
|
|
58
58
|
|
|
59
59
|
> The marketplace catalog is named `agent-native-apps` and the Plan plugin is `agent-native-visual-plans`, so the install target is always `agent-native-visual-plans@agent-native-apps`.
|
|
60
60
|
|
|
@@ -101,7 +101,7 @@ Under the hood, all three routes are produced from the same source by the `agent
|
|
|
101
101
|
|
|
102
102
|
## What's next {#whats-next}
|
|
103
103
|
|
|
104
|
-
- [**Visual Plans**](/docs/
|
|
104
|
+
- [**Visual Plans**](/docs/template-plan) — what the skills do and how to use them
|
|
105
105
|
- [**PR Visual Recap**](/docs/pr-visual-recap) — run `/visual-recap` automatically on every pull request
|
|
106
106
|
- [**Skills Guide**](/docs/skills-guide) — app-backed skills and the manifest format
|
|
107
107
|
- [**External Agents**](/docs/external-agents) — connect any MCP host and round-trip artifacts
|
|
@@ -5,7 +5,7 @@ description: "A GitHub Action that runs your repo's visual-recap skill on every
|
|
|
5
5
|
|
|
6
6
|
# PR Visual Recap
|
|
7
7
|
|
|
8
|
-
PR Visual Recap is a GitHub Action that turns every pull request into a **visual code review**. On each push, an LLM coding agent runs your repo's [`visual-recap`](/docs/
|
|
8
|
+
PR Visual Recap is a GitHub Action that turns every pull request into a **visual code review**. On each push, an LLM coding agent runs your repo's [`visual-recap`](/docs/template-plan) skill against the PR diff, publishes a structured recap plan to the hosted Plans app, and upserts **one sticky PR comment** that links to the interactive plan with an **inline screenshot** embedded right in the comment.
|
|
9
9
|
|
|
10
10
|
This is not a deterministic diff renderer. The action invokes a real coding agent (Claude Code CLI by default, or OpenAI Codex CLI) that reads the change, decides what matters, and authors the recap by calling the Plans MCP tool `create-visual-recap` — the same tool the `/visual-recap` slash command uses. You get a high-altitude, schema/API/before-after view of the change instead of a wall of raw diff.
|
|
11
11
|
|
|
@@ -99,5 +99,5 @@ The recap is a review aid layered on top of the normal PR flow:
|
|
|
99
99
|
|
|
100
100
|
## Related
|
|
101
101
|
|
|
102
|
-
- [Visual Plans](/docs/
|
|
102
|
+
- [Visual Plans](/docs/template-plan) — the `/visual-plan` and `/visual-recap` skills, the hosted Plans connector, and the interactive review surface this action publishes to.
|
|
103
103
|
- [Skills](/docs/skills-guide) — installing agent-native skills into your coding agent.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Plans"
|
|
3
|
-
description: "
|
|
2
|
+
title: "Visual Plans"
|
|
3
|
+
description: "Agent-Native Plans turns your coding agent's plan into a structured, reviewable document — diagrams, wireframes, annotated code, comments, and share links. Install once from the CLI; reviewers you share with edit as a guest and sign in only to save or share."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Plans
|
|
6
|
+
# Visual Plans
|
|
7
7
|
|
|
8
8
|
Agent-Native Plans is visual plan mode for coding agents. It turns an ordinary
|
|
9
9
|
Codex, Claude Code, Markdown, or pasted implementation plan into a structured
|
|
@@ -18,11 +18,20 @@ agent the same way.
|
|
|
18
18
|
|
|
19
19
|

|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
There are two ways into Plans:
|
|
22
|
+
|
|
23
|
+
- **From your coding agent (CLI)** — one command installs the skill, registers
|
|
24
|
+
the hosted Plans connector, and authenticates it.
|
|
25
|
+
- **In the browser** — anyone you share with can open the editor and create or
|
|
26
|
+
edit as a **guest, with no sign-up**. They sign in only when they want to save
|
|
27
|
+
or share.
|
|
28
|
+
|
|
29
|
+
## Install the skill {#install}
|
|
22
30
|
|
|
23
31
|
Use the Agent-Native CLI. This is the recommended setup because it installs the
|
|
24
|
-
Plans skill instructions, registers the hosted Plans MCP connector, and runs
|
|
25
|
-
client-specific auth/setup flow in one step
|
|
32
|
+
Plans skill instructions, registers the hosted Plans MCP connector, **and** runs
|
|
33
|
+
the client-specific auth/setup flow in one step, so your first tool call does not
|
|
34
|
+
hit an OAuth wall:
|
|
26
35
|
|
|
27
36
|
```bash
|
|
28
37
|
npx @agent-native/core@latest skills add visual-plan
|
|
@@ -36,10 +45,16 @@ agent-native skills add visual-plan
|
|
|
36
45
|
|
|
37
46
|
The command installs both commands: `/visual-plan` and `/visual-recap`.
|
|
38
47
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
48
|
+
Authentication is a one-time browser sign-in at setup — this is intended, and it
|
|
49
|
+
is what lets the agent persist and share the plans it generates. What the auth
|
|
50
|
+
step does depends on your client:
|
|
51
|
+
|
|
52
|
+
- **OAuth-capable hosts** (Claude Code) get a URL-only MCP entry plus a prompt to
|
|
53
|
+
run `/mcp` and choose **Authenticate**.
|
|
54
|
+
- **Codex / Cowork** run a short browser device-code flow: the CLI prints a code,
|
|
55
|
+
opens the verification page, and writes the connector once you approve.
|
|
56
|
+
- In a **non-interactive shell or CI**, the auth step is skipped and the exact
|
|
57
|
+
command to run later is printed for you.
|
|
43
58
|
|
|
44
59
|
By default the CLI targets Codex. Add `--client claude-code` or `--client all`
|
|
45
60
|
when you want to configure another host:
|
|
@@ -48,6 +63,22 @@ when you want to configure another host:
|
|
|
48
63
|
npx @agent-native/core@latest skills add visual-plan --client all
|
|
49
64
|
```
|
|
50
65
|
|
|
66
|
+
Pass `--no-connect` to register the connector without authenticating, then run
|
|
67
|
+
`agent-native connect https://plan.agent-native.com` whenever you are ready:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx @agent-native/core@latest skills add visual-plan --no-connect
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
To auto-generate a recap on **every pull request**, pass `--with-github-action`.
|
|
74
|
+
This writes a GitHub Action that runs the `visual-recap` skill on each PR and
|
|
75
|
+
posts an interactive recap plan with an inline screenshot as a sticky comment —
|
|
76
|
+
see [PR Visual Recap](/docs/pr-visual-recap).
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npx @agent-native/core@latest skills add visual-plan --with-github-action
|
|
80
|
+
```
|
|
81
|
+
|
|
51
82
|
If you only want the portable instruction file through the open Skills CLI, use:
|
|
52
83
|
|
|
53
84
|
```bash
|
|
@@ -57,6 +88,11 @@ npx skills add BuilderIO/agent-native --skill visual-plan
|
|
|
57
88
|
That installs the skill instructions only. It does not register the hosted MCP
|
|
58
89
|
connector, so use the Agent-Native CLI path when you want the one-command setup.
|
|
59
90
|
|
|
91
|
+
> **Prefer a one-install plugin?** Claude Code and Codex can add
|
|
92
|
+
> `BuilderIO/agent-native` directly as a plugin marketplace, which bundles the
|
|
93
|
+
> Plan skills _and_ the connector in one install and auto-updates as the skills
|
|
94
|
+
> improve — see [Plan plugin & marketplace](/docs/plan-plugin).
|
|
95
|
+
|
|
60
96
|
## Use it from your coding agent
|
|
61
97
|
|
|
62
98
|
After installation, ask your agent for the command that fits the work:
|
|
@@ -74,6 +110,10 @@ wrong direction would be costly. The returned Plans link opens the review UI so
|
|
|
74
110
|
you can annotate, correct, choose options, and ask for updates before code
|
|
75
111
|
changes begin.
|
|
76
112
|
|
|
113
|
+
When a Codex, Claude Code, Markdown, or pasted plan already exists, use
|
|
114
|
+
`/visual-plan`; the agent preserves that source plan and builds the richer review
|
|
115
|
+
surface from it instead of starting over.
|
|
116
|
+
|
|
77
117
|
If the first pass still has answerable decisions, the agent can place an
|
|
78
118
|
**Open Questions** form at the bottom of the same plan. Answering it and sending
|
|
79
119
|
it to the agent starts a revision turn against the existing plan.
|
|
@@ -91,14 +131,36 @@ it to the agent starts a revision turn against the existing plan.
|
|
|
91
131
|
prose block, visual comments include exact target metadata, and browser
|
|
92
132
|
handoff includes focused screenshots for a small set of visual/canvas comment
|
|
93
133
|
locations instead of one hard-to-read giant image.
|
|
94
|
-
- **Share with reviewers.** Hosted Plans can create private review links and
|
|
95
|
-
account-backed sharing. Viewing shared plans works from the browser; saving
|
|
96
|
-
and sharing require sign-in.
|
|
97
134
|
- **Export the result.** Keep an HTML, Markdown, or JSON receipt of the plan
|
|
98
135
|
when you need a source-control-friendly handoff.
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
136
|
+
|
|
137
|
+
## Editing in the browser as a guest {#guest}
|
|
138
|
+
|
|
139
|
+
People you share a plan with do not need to install anything. They open the Plans
|
|
140
|
+
editor and **create and edit with no sign-up** — they work as a guest. Signing in
|
|
141
|
+
is only required when someone wants to **save or share** their own work.
|
|
142
|
+
|
|
143
|
+
When a guest signs in, the plans they created as a guest are **claimed** into
|
|
144
|
+
their account, so nothing they built is lost.
|
|
145
|
+
|
|
146
|
+
Plan prose edits inline: click into any text section, type, format with the rich
|
|
147
|
+
editor toolbar or slash menu, and Plans autosaves the underlying markdown. Review
|
|
148
|
+
annotation mode temporarily turns text sections read-only so clicks can pin
|
|
149
|
+
feedback; leave review mode to keep editing prose.
|
|
150
|
+
|
|
151
|
+
## Sharing and commenting {#sharing}
|
|
152
|
+
|
|
153
|
+
Sharing and commenting are the workflows that need an account:
|
|
154
|
+
|
|
155
|
+
- **Viewing** a public or shared plan works for anyone with the link — no account
|
|
156
|
+
required.
|
|
157
|
+
- **Commenting** on a shared plan requires an agent-native account.
|
|
158
|
+
- **Sharing** a plan (publishing it to a link, private sharing, reviewer access,
|
|
159
|
+
cross-device or team review) requires signing in. Google sign-in appears when
|
|
160
|
+
the standard Google OAuth env vars are configured.
|
|
161
|
+
|
|
162
|
+
The hosted Plans connector lives at `https://plan.agent-native.com/_agent-native/mcp`.
|
|
163
|
+
Never put shared secrets in skill files.
|
|
102
164
|
|
|
103
165
|
## Useful prompts
|
|
104
166
|
|
|
@@ -108,6 +170,14 @@ it to the agent starts a revision turn against the existing plan.
|
|
|
108
170
|
- "Run `/visual-recap` on this PR so I can review the shape of the change first."
|
|
109
171
|
- "Use `/visual-recap` on the diff between `main` and this branch."
|
|
110
172
|
|
|
173
|
+
## Recovering from auth errors {#auth-errors}
|
|
174
|
+
|
|
175
|
+
If a Plans tool ever returns `needs auth`, `Unauthorized`, or `Session
|
|
176
|
+
terminated`, do not keep retrying it. Authenticate the connector with
|
|
177
|
+
`agent-native connect https://plan.agent-native.com` (or re-run `/mcp` →
|
|
178
|
+
**Authenticate** in an OAuth-capable host), then continue once the connector is
|
|
179
|
+
available.
|
|
180
|
+
|
|
111
181
|
## For developers
|
|
112
182
|
|
|
113
183
|
The rest of this doc is for anyone forking or self-hosting the Plans template.
|
|
@@ -130,10 +200,17 @@ The hosted app-backed skill uses:
|
|
|
130
200
|
The local template is useful when you are developing Plans itself, testing local
|
|
131
201
|
persistence, or running a fully self-hosted review surface.
|
|
132
202
|
|
|
203
|
+
### Local mode (advanced, offline)
|
|
204
|
+
|
|
205
|
+
For fully offline, no-account use, you can run the Plans app locally and sync
|
|
206
|
+
your plans to your repo as MDX. This local mode is a separate, advanced path —
|
|
207
|
+
not the default hosted flow — and is best when you need everything to stay on
|
|
208
|
+
your machine and in version control.
|
|
209
|
+
|
|
133
210
|
## What's next
|
|
134
211
|
|
|
135
|
-
- [**Visual Plans**](/docs/visual-plans) — the full skill flow and auth details
|
|
136
212
|
- [**PR Visual Recap**](/docs/pr-visual-recap) — run `/visual-recap` automatically on every pull request
|
|
213
|
+
- [**Plan plugin & marketplace**](/docs/plan-plugin) — install the Plan skills as a Claude Code or Codex plugin
|
|
137
214
|
- [**Skills**](/docs/skills-guide) — how Agent-Native installs skills
|
|
138
215
|
- [**MCP Clients**](/docs/mcp-clients) — configuring hosted MCP connectors
|
|
139
216
|
- [**Templates**](/docs/cloneable-saas) — the clone-and-own model
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-native/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.43.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=22"
|
|
@@ -198,6 +198,7 @@
|
|
|
198
198
|
"react-router": "^7.16.0",
|
|
199
199
|
"recharts": "3.8.1",
|
|
200
200
|
"remark-gfm": "^4.0.1",
|
|
201
|
+
"roughjs": "4.6.6",
|
|
201
202
|
"shiki": "^4.0.2",
|
|
202
203
|
"tailwind-merge": "^3.5.0",
|
|
203
204
|
"tiptap-markdown": "^0.9.0",
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Visual Plans"
|
|
3
|
-
description: "Turn your coding agent's plans into interactive, reviewable documents with /visual-plan. Install authenticates once; reviewers you share with edit as a guest, sign in only to save or share."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Visual Plans
|
|
7
|
-
|
|
8
|
-
`/visual-plan` is a coding-agent skill that turns the plan your agent would normally write in Markdown into a **structured visual document**: an optional pan/zoom wireframe canvas on top and a Notion-like technical document below, with diagrams, mockups, prototype options, answerable Open Questions, annotations, and comments you can react to before any code changes.
|
|
9
|
-
|
|
10
|
-
There are two ways into Plans:
|
|
11
|
-
|
|
12
|
-
- **From your coding agent (CLI)** — one command installs the skill, registers the hosted Plans connector, and authenticates it.
|
|
13
|
-
- **In the browser** — anyone you share with can open the editor and create or edit as a **guest, with no sign-up**. They sign in only when they want to save or share.
|
|
14
|
-
|
|
15
|
-
## Coding agent setup {#install}
|
|
16
|
-
|
|
17
|
-
Install with the Agent-Native CLI. The command installs the skill instructions, registers the hosted Plans MCP connector, **and authenticates it in the same step**, so your first tool call does not hit an OAuth wall:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
agent-native skills add visual-plan
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Authentication is a one-time browser sign-in at setup — this is intended, and it is what lets the agent persist and share the plans it generates. This also installs the companion `/visual-recap` command for reviewing changes that already landed (see [Invoking the skill](#invoke)).
|
|
24
|
-
|
|
25
|
-
> **Prefer a one-install plugin?** Claude Code and Codex can add `BuilderIO/agent-native` directly as a plugin marketplace, which bundles the six Plan skills _and_ the connector in one install and auto-updates as the skills improve — see [Plan plugin & marketplace](/docs/plan-plugin).
|
|
26
|
-
|
|
27
|
-
What the auth step does depends on your client:
|
|
28
|
-
|
|
29
|
-
- **OAuth-capable hosts** (Claude Code) get a URL-only MCP entry plus a prompt to run `/mcp` and choose **Authenticate**.
|
|
30
|
-
- **Codex / Cowork** run a short browser device-code flow: the CLI prints a code, opens the verification page, and writes the connector once you approve.
|
|
31
|
-
- In a **non-interactive shell or CI**, the auth step is skipped and the exact command to run later is printed for you.
|
|
32
|
-
|
|
33
|
-
Pass `--no-connect` to register the connector without authenticating, then run `agent-native connect https://plan.agent-native.com` whenever you are ready:
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
agent-native skills add visual-plan --no-connect
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
To auto-generate a recap on **every pull request**, pass `--with-github-action`. This writes a GitHub Action that runs the `visual-recap` skill on each PR and posts an interactive recap plan with an inline screenshot as a sticky comment — see [PR Visual Recap](/docs/pr-visual-recap).
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
agent-native skills add visual-plan --with-github-action
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## Invoking the skill {#invoke}
|
|
46
|
-
|
|
47
|
-
Once installed, there are two commands:
|
|
48
|
-
|
|
49
|
-
- `/visual-plan` — plan **before** implementation. The canonical command for any rich plan: architecture, backend, refactors, or UI. It pulls in diagrams, wireframes, mockups, clickable prototypes, and implementation maps as the work calls for them, and can open with a short visual intake step when the direction is still open.
|
|
50
|
-
- `/visual-recap` — review **after** the change. Turns a PR, commit, branch, or git diff that already landed into a high-altitude recap — schema, API, file, and before/after blocks instead of a wall of raw diff. A recap is a review aid, not a replacement for reading the diff. See [PR Visual Recap](/docs/pr-visual-recap) to run it automatically on every pull request.
|
|
51
|
-
|
|
52
|
-
The agent gates hard: it only builds a polished visual plan when a wrong direction would be costly, and skips it for trivial, unambiguous work. Each command generates a plan and opens the editor.
|
|
53
|
-
|
|
54
|
-
When a Codex, Claude Code, Markdown, or pasted plan already exists, use `/visual-plan`. The agent should preserve that source plan and build the richer review surface from it instead of starting over.
|
|
55
|
-
|
|
56
|
-
When a plan has unresolved decisions that are useful to answer after the first pass, the agent can put them in an **Open Questions** form at the bottom of the same plan. You can choose single or multiple options, fill in freeform answers, and send the answers back to the agent to revise the plan.
|
|
57
|
-
|
|
58
|
-
## Editing in the browser as a guest {#guest}
|
|
59
|
-
|
|
60
|
-
People you share a plan with do not need to install anything. They open the Plans editor and **create and edit with no sign-up** — they work as a guest. Signing in is only required when someone wants to **save or share** their own work.
|
|
61
|
-
|
|
62
|
-
When a guest signs in, the plans they created as a guest are **claimed** into their account, so nothing they built is lost.
|
|
63
|
-
|
|
64
|
-
Plan prose edits inline: click into any text section, type, format with the rich editor toolbar or slash menu, and Plans autosaves the underlying markdown. Review annotation mode temporarily turns text sections read-only so clicks can pin feedback; leave review mode to keep editing prose.
|
|
65
|
-
|
|
66
|
-
## Sharing and commenting {#sharing}
|
|
67
|
-
|
|
68
|
-
Sharing and commenting are the workflows that need an account:
|
|
69
|
-
|
|
70
|
-
- **Viewing** a public or shared plan works for anyone with the link — no account required.
|
|
71
|
-
- **Commenting** on a shared plan requires an agent-native account.
|
|
72
|
-
- **Sharing** a plan (publishing it to a link, private sharing, reviewer access, cross-device or team review) requires signing in. Google sign-in appears when the standard Google OAuth env vars are configured.
|
|
73
|
-
|
|
74
|
-
The hosted Plans connector lives at `https://plan.agent-native.com/_agent-native/mcp`. Never put shared secrets in skill files.
|
|
75
|
-
|
|
76
|
-
## Local mode (advanced, offline) {#local}
|
|
77
|
-
|
|
78
|
-
For fully offline, no-account use, you can run the Plans app locally and sync your plans to your repo as MDX. This local mode is a separate, advanced path — not the default hosted flow — and is best when you need everything to stay on your machine and in version control.
|
|
79
|
-
|
|
80
|
-
## Recovering from auth errors {#auth-errors}
|
|
81
|
-
|
|
82
|
-
If a Plans tool ever returns `needs auth`, `Unauthorized`, or `Session terminated`, do not keep retrying it. Authenticate the connector with `agent-native connect https://plan.agent-native.com` (or re-run `/mcp` → **Authenticate** in an OAuth-capable host), then continue once the connector is available.
|