@cyber-dash-tech/revela 0.18.5 → 0.18.6
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 +4 -4
- package/README.zh-CN.md +4 -4
- package/package.json +1 -1
- package/plugins/revela/.mcp.json +1 -1
- package/plugins/revela/skills/revela-helper/SKILL.md +5 -1
- package/plugins/revela/skills/revela-make-deck/SKILL.md +26 -38
- package/plugins/revela/skills/revela-research/SKILL.md +34 -5
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ To install globally, add the same entry to `~/.config/opencode/opencode.json`.
|
|
|
34
34
|
Requirements:
|
|
35
35
|
|
|
36
36
|
- The Codex CLI must be installed and the `codex` command must be available in your shell.
|
|
37
|
-
- Your environment must be able to run `npx`; Revela uses `npx -y @cyber-dash-tech/revela@0.18.
|
|
37
|
+
- Your environment must be able to run `npx`; Revela uses `npx -y @cyber-dash-tech/revela@0.18.6 mcp` to start the MCP server.
|
|
38
38
|
- For interactive Review Apply actions, `codex exec` must also work because the Review UI uses it after saved comments are applied.
|
|
39
39
|
|
|
40
40
|
Optional preflight:
|
|
@@ -55,17 +55,17 @@ npm_config_cache=/tmp/revela-npm-cache bun run smoke:mcp-pack
|
|
|
55
55
|
Install Revela through the Codex Git marketplace:
|
|
56
56
|
|
|
57
57
|
```bash
|
|
58
|
-
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.18.
|
|
58
|
+
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.18.6
|
|
59
59
|
codex plugin add revela@revela
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
The Git marketplace install provides the Codex plugin shell, skills, hooks, and MCP configuration. When Codex starts the Revela MCP server for the first time, it runs `npx -y @cyber-dash-tech/revela@0.18.
|
|
62
|
+
The Git marketplace install provides the Codex plugin shell, skills, hooks, and MCP configuration. When Codex starts the Revela MCP server for the first time, it runs `npx -y @cyber-dash-tech/revela@0.18.6 mcp` so npm can fetch the published package and its dependencies.
|
|
63
63
|
|
|
64
64
|
You do not need to run `bun install` inside the Codex marketplace clone.
|
|
65
65
|
|
|
66
66
|
Start a new Codex thread after installing so Codex loads the Revela skills, MCP tools, and hooks.
|
|
67
67
|
|
|
68
|
-
Codex uses five Revela skills: `revela-helper` for status and active design/domain, `revela-research` for local and web research saved under `researches
|
|
68
|
+
Codex uses five Revela skills: `revela-helper` for status and active design/domain, `revela-research` for local and web research saved under `researches/` plus the design-aware `deck-plan.md` handoff, `revela-make-deck` for generating `decks/*.html` from an existing plan, `revela-review` for the Review UI, and `revela-export` for PDF/PPTX/PNG.
|
|
69
69
|
|
|
70
70
|
For release-aligned local validation, run `bun run smoke:mcp-pack`. It packs the current checkout to a temporary npm tarball and starts the MCP server through `npx`, matching the published Codex launcher path without requiring a registry publish.
|
|
71
71
|
|
package/README.zh-CN.md
CHANGED
|
@@ -34,7 +34,7 @@ Revela 可在 [OpenCode](https://opencode.ai) 和 Codex 中使用,把来源材
|
|
|
34
34
|
环境要求:
|
|
35
35
|
|
|
36
36
|
- 需要已安装 Codex CLI,并且 shell 中可以执行 `codex`。
|
|
37
|
-
- 环境中需要可以执行 `npx`;Revela 会用 `npx -y @cyber-dash-tech/revela@0.18.
|
|
37
|
+
- 环境中需要可以执行 `npx`;Revela 会用 `npx -y @cyber-dash-tech/revela@0.18.6 mcp` 启动 MCP server。
|
|
38
38
|
- 如果使用 Review UI 的 Apply,需要 `codex exec` 可用;评论会先保存,点击 Apply 后才执行修复。
|
|
39
39
|
|
|
40
40
|
可选的安装前检查:
|
|
@@ -55,17 +55,17 @@ npm_config_cache=/tmp/revela-npm-cache bun run smoke:mcp-pack
|
|
|
55
55
|
通过 Codex Git marketplace 安装 Revela:
|
|
56
56
|
|
|
57
57
|
```bash
|
|
58
|
-
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.18.
|
|
58
|
+
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.18.6
|
|
59
59
|
codex plugin add revela@revela
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Git marketplace 安装的是 Codex plugin 壳、skills、hooks 和 MCP 配置。Codex 第一次启动 Revela MCP server 时,会运行 `npx -y @cyber-dash-tech/revela@0.18.
|
|
62
|
+
Git marketplace 安装的是 Codex plugin 壳、skills、hooks 和 MCP 配置。Codex 第一次启动 Revela MCP server 时,会运行 `npx -y @cyber-dash-tech/revela@0.18.6 mcp`,由 npm 获取已发布 package 及其 dependencies。
|
|
63
63
|
|
|
64
64
|
不需要在 Codex marketplace clone 里运行 `bun install`。
|
|
65
65
|
|
|
66
66
|
安装后开启一个新的 Codex thread,让 Codex 加载 Revela 的 skills、MCP tools 和 hooks。
|
|
67
67
|
|
|
68
|
-
Codex 使用五个 Revela skills:`revela-helper` 查看状态和 active design/domain,`revela-research`
|
|
68
|
+
Codex 使用五个 Revela skills:`revela-helper` 查看状态和 active design/domain,`revela-research` 调研本地与网络资料、保存到 `researches/`,并产出 design-aware `deck-plan.md` handoff;`revela-make-deck` 基于已有 plan 生成 `decks/*.html`,`revela-review` 打开 Review UI,`revela-export` 导出 PDF/PPTX/PNG。
|
|
69
69
|
|
|
70
70
|
如果要按发布路径做本地验证,运行 `bun run smoke:mcp-pack`。它会把当前 checkout 打成临时 npm tarball,再通过 `npx` 启动 MCP server,不需要先发布到 registry。
|
|
71
71
|
|
package/package.json
CHANGED
package/plugins/revela/.mcp.json
CHANGED
|
@@ -38,7 +38,11 @@ Report:
|
|
|
38
38
|
- Runtime/version status from `revela_doctor`.
|
|
39
39
|
- Active design and active domain.
|
|
40
40
|
- Workspace artifact status: whether `researches/`, `deck-plan.md`, `decks/*.html`, and `assets/` appear available.
|
|
41
|
-
- Recommended next step:
|
|
41
|
+
- Recommended next step:
|
|
42
|
+
- No `researches/`: run `revela-research`.
|
|
43
|
+
- Research exists but no `deck-plan.md`: continue `revela-research` to the Planning Handoff.
|
|
44
|
+
- Valid `deck-plan.md` but no deck artifact: run `revela-make-deck`.
|
|
45
|
+
- Existing deck artifact: run `revela-review` or `revela-export` depending on the user goal.
|
|
42
46
|
|
|
43
47
|
## Must Not
|
|
44
48
|
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: revela-make-deck
|
|
3
|
-
description:
|
|
3
|
+
description: Generate Revela HTML deck artifacts in Codex from an existing deck-plan.md and active design files.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Revela Make Deck
|
|
7
7
|
|
|
8
|
-
Use this skill when the user asks to
|
|
8
|
+
Use this skill when the user asks to make, generate, render, or update a Revela HTML deck from an existing `deck-plan.md`.
|
|
9
9
|
|
|
10
10
|
## Contract
|
|
11
11
|
|
|
@@ -14,14 +14,16 @@ Use this skill when the user asks to plan, make, generate, or update a Revela de
|
|
|
14
14
|
- Active/requested design tools define valid layouts, slots, components, nesting hints, and HTML writing rules.
|
|
15
15
|
- Active/requested domain guidance may inform communication framing, but it is not source evidence.
|
|
16
16
|
- Generated artifacts live under `decks/*.html`.
|
|
17
|
-
- Do not require a Narrative Vault before
|
|
18
|
-
-
|
|
17
|
+
- Do not require a Narrative Vault before generating a deck.
|
|
18
|
+
- This skill does not own normal plan authoring; `revela-research` owns source preparation and `deck-plan.md` planning handoff.
|
|
19
|
+
- `deck-plan.md` is required for normal deck generation.
|
|
19
20
|
|
|
20
21
|
## Preconditions
|
|
21
22
|
|
|
22
|
-
-
|
|
23
|
-
- If research is thin, the user may explicitly ask to continue with limited materials; then record source limitations in `deck-plan.md`.
|
|
23
|
+
- Required: readable `deck-plan.md`.
|
|
24
24
|
- An active or user-requested design must be readable.
|
|
25
|
+
- If `deck-plan.md` is missing, stop and tell the user to run `revela-research` or continue `revela-research` to the Planning Handoff.
|
|
26
|
+
- If `deck-plan.md` is structurally invalid, only repair technical plan diagnostics reported during render preflight.
|
|
25
27
|
|
|
26
28
|
## Inputs
|
|
27
29
|
|
|
@@ -29,18 +31,18 @@ Use this skill when the user asks to plan, make, generate, or update a Revela de
|
|
|
29
31
|
- Reviewed workspace materials and material review records.
|
|
30
32
|
- `assets/`
|
|
31
33
|
- User deck objective, audience, and constraints.
|
|
32
|
-
- Existing `deck-plan.md
|
|
34
|
+
- Existing `deck-plan.md`.
|
|
33
35
|
- Active/requested design and optional active/requested domain.
|
|
34
36
|
|
|
35
37
|
## Required Design Tools
|
|
36
38
|
|
|
37
|
-
Before
|
|
39
|
+
Before render preflight:
|
|
38
40
|
|
|
39
41
|
1. Call `revela_design_list`.
|
|
40
42
|
2. Call `revela_design_read` with `section: "rules"` for the active/requested design.
|
|
41
43
|
3. Call `revela_design_inventory`.
|
|
42
44
|
|
|
43
|
-
Before
|
|
45
|
+
Before HTML writing:
|
|
44
46
|
|
|
45
47
|
1. Call `revela_read_deck_plan`.
|
|
46
48
|
2. Read the returned `htmlWritingBatches`.
|
|
@@ -48,38 +50,22 @@ Before Render phase HTML writing:
|
|
|
48
50
|
4. Call `revela_design_read_component` for each component used in the current batch.
|
|
49
51
|
5. Fetch chart rules before creating or modifying ECharts.
|
|
50
52
|
|
|
51
|
-
## Plan
|
|
53
|
+
## Plan Preflight And Repair
|
|
52
54
|
|
|
53
|
-
|
|
55
|
+
Call `revela_read_deck_plan` before HTML generation and treat the result as the render blueprint.
|
|
54
56
|
|
|
55
|
-
|
|
56
|
-
2. Read active/requested domain guidance only as framing context; never cite it as evidence.
|
|
57
|
-
3. Use design inventory to choose valid layouts, slots, components, and component nesting.
|
|
58
|
-
4. Write or repair `deck-plan.md` directly. Do not use structured upsert tools for normal plan authoring.
|
|
59
|
-
5. Call `revela_read_deck_plan` after writing or repairing `deck-plan.md`.
|
|
60
|
-
6. If diagnostics report layout, slot, component, `children`, or `sourceLinks` issues, patch the Markdown directly and call `revela_read_deck_plan` again.
|
|
57
|
+
Allowed plan repairs are limited to technical diagnostics from `revela_read_deck_plan`:
|
|
61
58
|
|
|
62
|
-
|
|
59
|
+
- Broken Markdown/frontmatter structure.
|
|
60
|
+
- Invalid or missing `sourceLinks` field structure, without adding new unsupported source links.
|
|
61
|
+
- Layout, slot, component, or `children` names that do not match `revela_design_inventory`.
|
|
62
|
+
- Component nesting fixes such as using `box.children` when the selected component model requires nested semantic groups.
|
|
63
63
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
Each slide block must include:
|
|
67
|
-
|
|
68
|
-
- Slide title and role when relevant.
|
|
69
|
-
- `#### Content Plan`
|
|
70
|
-
- `#### Source Links` for materials, findings, assets, URLs, and caveats.
|
|
71
|
-
- `#### Design Plan`
|
|
72
|
-
- Selected layout from design inventory.
|
|
73
|
-
- Component plan using component names from design inventory.
|
|
74
|
-
- Valid slots from the selected layout.
|
|
75
|
-
- Valid component nesting hints, including `box.children` when multiple child components support one semantic idea.
|
|
76
|
-
- Unresolved inputs, source limitations, and user review notes instead of AI-authored caveat/risk judgement.
|
|
77
|
-
|
|
78
|
-
Do not duplicate the same child as both nested and top-level.
|
|
64
|
+
Do not redesign the argument structure, add new slides, remove supported slides, rewrite claims, or add source links that were not reviewed or saved by `revela-research`. If normal plan authoring is needed, stop and send the user back to `revela-research` Planning Handoff.
|
|
79
65
|
|
|
80
66
|
## Render Phase
|
|
81
67
|
|
|
82
|
-
Use this phase when the user asks to make, generate, render, or update an HTML deck.
|
|
68
|
+
Use this phase when the user asks to make, generate, render, or update an HTML deck and `deck-plan.md` is readable.
|
|
83
69
|
|
|
84
70
|
1. Call `revela_read_deck_plan` before HTML generation and follow the current projection.
|
|
85
71
|
2. Read `htmlWritingBatches` before any HTML write. `revela_read_deck_plan` is QA/diagnostics, not a writer.
|
|
@@ -95,13 +81,15 @@ Use this phase when the user asks to make, generate, render, or update an HTML d
|
|
|
95
81
|
|
|
96
82
|
## Outputs
|
|
97
83
|
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
84
|
+
- `decks/*.html`.
|
|
85
|
+
- Artifact QA status.
|
|
86
|
+
- Unresolved render/design issues and any plan diagnostics that require `revela-research` Planning Handoff.
|
|
101
87
|
|
|
102
88
|
## Must Not
|
|
103
89
|
|
|
104
|
-
- Do not skip `deck-plan.md` for normal decks.
|
|
90
|
+
- Do not skip or synthesize `deck-plan.md` for normal decks.
|
|
91
|
+
- Do not claim ownership of normal plan authoring.
|
|
92
|
+
- Do not write a new `deck-plan.md` when it is missing.
|
|
105
93
|
- Do not use design inventory names, slots, or components that were not returned by the active/requested design tools.
|
|
106
94
|
- Do not use a slot that does not belong to the selected layout.
|
|
107
95
|
- Do not patch more than 5 slide sections in one HTML write.
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: revela-research
|
|
3
|
-
description: Research workspace materials and public sources for a Revela deck objective, using active domain guidance
|
|
3
|
+
description: Research workspace materials and public sources for a Revela deck objective, using active domain/design guidance to save source-linked findings and hand off deck-plan.md.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Revela Research
|
|
7
7
|
|
|
8
|
-
Use this skill when the user asks to start from a goal, inspect local materials, research missing inputs, gather public support, save findings,
|
|
8
|
+
Use this skill when the user asks to start from a goal, inspect local materials, research missing inputs, gather public support, save findings, find source-linked examples/assets, or prepare the deck planning handoff.
|
|
9
9
|
|
|
10
10
|
## Contract
|
|
11
11
|
|
|
12
12
|
- Research is the source-preparation workflow for Codex Revela.
|
|
13
|
-
- Research output is saved under `researches/**/*.md`
|
|
13
|
+
- Research output is saved under `researches/**/*.md` and, when the user goal is a deck and materials are sufficient, handed off as `deck-plan.md`.
|
|
14
14
|
- Local materials are only usable after direct text review or extracted read-view review.
|
|
15
15
|
- Active/requested domain guidance informs audience, decision framing, claim standards, evidence expectations, objection/risk interpretation, and research-gap priority.
|
|
16
16
|
- Domain guidance is not evidence and must never be cited as proof for factual claims.
|
|
17
|
-
-
|
|
17
|
+
- Active/requested design tools define valid layouts, slots, components, nesting hints, and deck-plan design vocabulary.
|
|
18
|
+
- `deck-plan.md` is the formal research-to-make-deck handoff when a deck objective is sufficiently supported.
|
|
19
|
+
- Do not create deck artifacts, a Narrative Vault, or canonical evidence bindings during research.
|
|
18
20
|
- Do not invent URLs, quotes, page references, numbers, caveats, or licenses.
|
|
19
21
|
|
|
20
22
|
## Preconditions
|
|
@@ -40,6 +42,13 @@ Use this skill when the user asks to start from a goal, inspect local materials,
|
|
|
40
42
|
7. Call `revela_check_material_intake` before reporting research readiness.
|
|
41
43
|
8. Use external research only for public facts, user-authorized questions, or gaps not covered by local materials.
|
|
42
44
|
9. Save useful findings with `revela_research_save`.
|
|
45
|
+
10. For deck goals with sufficient materials, run Planning Handoff:
|
|
46
|
+
- Call `revela_design_list`.
|
|
47
|
+
- Call `revela_design_read` with `section: "rules"` for the active/requested design.
|
|
48
|
+
- Call `revela_design_inventory`.
|
|
49
|
+
- Write `deck-plan.md` directly from reviewed materials, saved findings, assets, user intent, active domain framing, and active design vocabulary.
|
|
50
|
+
- Call `revela_read_deck_plan` after writing `deck-plan.md`.
|
|
51
|
+
- If diagnostics report `sourceLinks`, layout, slot, component, or `children` issues, patch `deck-plan.md` directly and call `revela_read_deck_plan` again.
|
|
43
52
|
|
|
44
53
|
## Finding Requirements
|
|
45
54
|
|
|
@@ -59,13 +68,33 @@ If a finding is context only, label it as context and do not present it as proof
|
|
|
59
68
|
|
|
60
69
|
- `researches/{topic}/{filename}.md`
|
|
61
70
|
- Material review records for reviewed Office/PDF sources.
|
|
71
|
+
- `deck-plan.md` when the user goal is a deck and reviewed materials/findings are sufficient for a traceable plan.
|
|
62
72
|
- Source limitations and unresolved gaps.
|
|
63
73
|
- A clear statement of whether `revela-make-deck` can proceed or whether more research is needed.
|
|
64
74
|
|
|
75
|
+
## Planning Handoff
|
|
76
|
+
|
|
77
|
+
Use this final stage only for deck goals. If sources are too thin, report unresolved inputs and source limitations instead of drafting unsupported slides.
|
|
78
|
+
|
|
79
|
+
Every `deck-plan.md` handoff should include Cover, Table of Contents, Closing, 3-5 chapter headings, explicit slide ranges, and `---` slide separators under `## Slides`.
|
|
80
|
+
|
|
81
|
+
Each non-structural slide block must include:
|
|
82
|
+
|
|
83
|
+
- Slide title and role when relevant.
|
|
84
|
+
- `#### Content Plan`
|
|
85
|
+
- `#### Source Links` for materials, findings, assets, URLs, and caveats.
|
|
86
|
+
- `#### Design Plan`
|
|
87
|
+
- Selected layout from design inventory.
|
|
88
|
+
- Component plan using component names from design inventory.
|
|
89
|
+
- Valid slots from the selected layout.
|
|
90
|
+
- Valid component nesting hints, including `box.children` when multiple child components support one semantic idea.
|
|
91
|
+
- Unresolved inputs, source limitations, and user review notes instead of AI-authored caveat/risk judgement.
|
|
92
|
+
|
|
93
|
+
Do not duplicate the same child as both nested and top-level. Do not add source links that were not reviewed or saved during research.
|
|
94
|
+
|
|
65
95
|
## Must Not
|
|
66
96
|
|
|
67
97
|
- Do not generate `revela-narrative/`.
|
|
68
|
-
- Do not write `deck-plan.md`.
|
|
69
98
|
- Do not write `decks/*.html`.
|
|
70
99
|
- Do not bind findings into a Narrative Vault or canonical evidence graph.
|
|
71
100
|
- Do not treat domain guidance as source evidence.
|