@cyber-dash-tech/revela 0.17.7 → 0.17.8
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 +56 -6
- package/README.zh-CN.md +56 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
**English** | [中文](README.zh-CN.md)
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/@cyber-dash-tech/revela) [](LICENSE) [](https://www.npmjs.com/package/@cyber-dash-tech/revela) [](LICENSE) [](tests/) [](https://opencode.ai) [](https://bun.sh)
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<img src="assets/img/logo.png" alt="Revela" width="560" />
|
|
@@ -34,13 +34,13 @@ To install globally, add the same entry to `~/.config/opencode/opencode.json`.
|
|
|
34
34
|
Install Revela through the Codex Git marketplace:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref
|
|
37
|
+
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.17.8
|
|
38
38
|
codex plugin add revela@revela
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Install from the full repository ref. Do not use a sparse checkout limited to `plugins/revela`; the Codex plugin resolves the shared runtime, built-in designs, and domains from the repository snapshot.
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
Start a new Codex thread after installing so Codex loads the Revela skills, MCP tools, and hooks.
|
|
44
44
|
|
|
45
45
|
## Built-In Designs
|
|
46
46
|
|
|
@@ -84,11 +84,61 @@ In Codex, ask Revela to list or switch domains; the active domain guides narrati
|
|
|
84
84
|
|
|
85
85
|
## Quick Start
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
Use these prompts in Codex from the workspace that contains your source materials.
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
1. Choose the narrative domain before authoring so Revela frames the audience, decision, risks, and objections for your context.
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
```text
|
|
92
|
+
Use Revela to list available domains, switch to the consulting domain, and use that framing for the narrative workflow.
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
2. Choose the deck design before rendering so generated artifacts use the intended visual language.
|
|
96
|
+
|
|
97
|
+
```text
|
|
98
|
+
Use Revela to list available designs, switch to the summit design, and use it for the next deck.
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
3. Initialize the narrative from local materials. Init grounds the narrative in the workspace and surfaces gaps; it does not replace the research step.
|
|
102
|
+
|
|
103
|
+
```text
|
|
104
|
+
Use Revela to initialize this workspace. Read the local materials, identify the audience, decision, thesis, claims, existing evidence, risks, objections, and gaps, then create or update the narrative vault.
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
4. Research the gaps and bind only source-supported evidence into the narrative.
|
|
108
|
+
|
|
109
|
+
```text
|
|
110
|
+
Use Revela research to inspect the current narrative gaps, derive research targets, gather or evaluate findings, save research under researches/, and bind only source-supported evidence back into the narrative vault.
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
5. Read Story before rendering to inspect the claim flow, evidence support, caveats, unsupported scope, and open gaps.
|
|
114
|
+
|
|
115
|
+
```text
|
|
116
|
+
Use Revela Story to show the current claim flow, evidence support, caveats, unsupported scope, and open gaps.
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
6. Make an HTML deck from the canonical narrative and deck plan.
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
Use Revela to make a deck from the current narrative. Create or update the deck plan, generate an HTML deck under decks/, run deck QA, and repair hard QA errors.
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
7. Review the generated deck for traceability, diagnostics, and targeted edits.
|
|
126
|
+
|
|
127
|
+
```text
|
|
128
|
+
Use Revela to review the generated deck. Open the Review UI for the HTML deck and also summarize diagnostics.
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
8. Export a PDF after deck QA passes.
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
Use Revela to export the deck to PDF.
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
9. Export an editable PPTX after deck QA passes.
|
|
138
|
+
|
|
139
|
+
```text
|
|
140
|
+
Use Revela to export the deck to PPTX.
|
|
141
|
+
```
|
|
92
142
|
|
|
93
143
|
## Review A Deck
|
|
94
144
|
|
package/README.zh-CN.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[English](README.md) | **中文**
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/@cyber-dash-tech/revela) [](LICENSE) [](https://www.npmjs.com/package/@cyber-dash-tech/revela) [](LICENSE) [](tests/) [](https://opencode.ai) [](https://bun.sh)
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<img src="assets/img/logo.png" alt="Revela" width="560" />
|
|
@@ -34,13 +34,13 @@ Revela 可在 [OpenCode](https://opencode.ai) 和 Codex 中使用，把来源材
|
|
|
34
34
|
通过 Codex Git marketplace 安装 Revela：
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref
|
|
37
|
+
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref v0.17.8
|
|
38
38
|
codex plugin add revela@revela
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
请从完整仓库 ref 安装。不要使用仅包含 `plugins/revela` 的 sparse checkout；Codex plugin 会从仓库快照中解析 shared runtime、内置 designs 和 domains。
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
安装后开启一个新的 Codex thread，让 Codex 加载 Revela 的 skills、MCP tools 和 hooks。
|
|
44
44
|
|
|
45
45
|
## 内置设计
|
|
46
46
|
|
|
@@ -84,11 +84,61 @@ Domain 提供特定场景的叙事 guidance，例如 consulting、product 或 in
|
|
|
84
84
|
|
|
85
85
|
## Quick Start
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
在包含来源材料的 workspace 中打开 Codex，然后按下面步骤逐条发送 prompt。
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
1. 先选择 domain，让 Revela 按你的沟通场景 framing 受众、决策、风险和潜在质疑。
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
```text
|
|
92
|
+
用 Revela 列出可用 domains，切换到 consulting domain，并把这个 framing 用在后续 narrative workflow 中。
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
2. 再选择 design，让后续生成的 deck 使用指定视觉风格。
|
|
96
|
+
|
|
97
|
+
```text
|
|
98
|
+
用 Revela 列出可用 designs，切换到 summit design，并把它用于下一次 deck 生成。
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
3. 从本地材料初始化 narrative。Init 负责基于 workspace 做 grounding 并暴露 gap；它不替代 research 步骤。
|
|
102
|
+
|
|
103
|
+
```text
|
|
104
|
+
用 Revela 初始化这个 workspace。读取本地材料，识别受众、决策目标、thesis、claims、已有 evidence、risks、objections 和 gaps，然后创建或更新 narrative vault。
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
4. 针对 gap 做 research，并且只把来源明确支持的 evidence 绑定回 narrative。
|
|
108
|
+
|
|
109
|
+
```text
|
|
110
|
+
用 Revela research 检查当前 narrative gaps，生成 research targets，收集或评估 findings，把 research 保存到 researches/，并且只把有来源支撑的 evidence 绑定回 narrative vault。
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
5. 生成 deck 前先读 Story，检查 claim flow、证据支撑、caveats、unsupported scope 和 open gaps。
|
|
114
|
+
|
|
115
|
+
```text
|
|
116
|
+
用 Revela Story 展示当前 claim flow、evidence support、caveats、unsupported scope 和 open gaps。
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
6. 从 canonical narrative 和 deck plan 生成 HTML deck。
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
用 Revela 基于当前 narrative 制作 deck。创建或更新 deck plan，在 decks/ 下生成 HTML deck，运行 deck QA，并修复 hard QA errors。
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
7. Review 生成后的 deck，检查 traceability、diagnostics，并做定向修改。
|
|
126
|
+
|
|
127
|
+
```text
|
|
128
|
+
用 Revela review 生成好的 deck。打开这个 HTML deck 的 Review UI，并总结 diagnostics。
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
8. QA 通过后导出 PDF。
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
用 Revela 把 deck 导出为 PDF。
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
9. QA 通过后导出可编辑 PPTX。
|
|
138
|
+
|
|
139
|
+
```text
|
|
140
|
+
用 Revela 把 deck 导出为 PPTX。
|
|
141
|
+
```
|
|
92
142
|
|
|
93
143
|
## Review Deck
|
|
94
144
|
|
package/package.json
CHANGED