@osovv/grace-cli 3.6.0 → 3.7.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 +200 -173
- package/package.json +1 -1
- package/src/grace.ts +1 -1
package/README.md
CHANGED
|
@@ -1,264 +1,291 @@
|
|
|
1
|
-
# GRACE
|
|
1
|
+
# GRACE Marketplace and CLI
|
|
2
2
|
|
|
3
|
-
**GRACE**
|
|
3
|
+
**GRACE** means **Graph-RAG Anchored Code Engineering**: a contract-first AI engineering methodology built around semantic markup, shared XML artifacts, verification planning, and knowledge-graph navigation.
|
|
4
4
|
|
|
5
|
-
This repository
|
|
5
|
+
This repository ships the GRACE skills plus the optional `grace` CLI. It is a packaging and distribution repository, not an end-user application.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- verification-first execution
|
|
9
|
-
- semantic markup for navigation and patching
|
|
10
|
-
- knowledge-graph synchronization
|
|
11
|
-
- controller-managed sequential or multi-agent implementation
|
|
7
|
+
Current packaged version: `3.7.0`
|
|
12
8
|
|
|
13
|
-
|
|
9
|
+
## What This Repository Ships
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
- Canonical GRACE skills in `skills/grace/*`
|
|
12
|
+
- Packaged Claude marketplace mirror in `plugins/grace/skills/grace/*`
|
|
13
|
+
- Marketplace metadata in `.claude-plugin/marketplace.json`
|
|
14
|
+
- Packaged plugin manifest in `plugins/grace/.claude-plugin/plugin.json`
|
|
15
|
+
- OpenPackage metadata in `openpackage.yml`
|
|
16
|
+
- Optional Bun-powered CLI package `@osovv/grace-cli`
|
|
16
17
|
|
|
17
|
-
|
|
18
|
-
- Clarified across the shipped skills when to use `grace lint`, `grace module show`, and `grace file show` to move between public shared-doc context and private file-local context.
|
|
19
|
-
- Kept `grace lint` as the fast integrity gate while expanding the CLI into context navigation for agents and humans.
|
|
18
|
+
The published CLI currently gives you:
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
- `grace lint` for integrity checks
|
|
21
|
+
- `grace module find` for module resolution across shared docs and file-local markup
|
|
22
|
+
- `grace module show` for shared/public module context
|
|
23
|
+
- `grace file show` for file-local/private implementation context
|
|
22
24
|
|
|
23
|
-
|
|
24
|
-
- `.claude-plugin/` - Claude Code marketplace packaging
|
|
25
|
-
- `openpackage.yml` - OpenPackage metadata
|
|
25
|
+
## Why GRACE
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
GRACE is designed for AI-assisted engineering where agents need stable navigation, explicit contracts, and reusable verification evidence.
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Core ideas:
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
- shared artifacts define the public module boundary
|
|
32
|
+
- file-local markup defines private implementation detail
|
|
33
|
+
- contracts describe expected behavior before code changes spread
|
|
34
|
+
- verification is planned, named, and reused instead of improvised per task
|
|
35
|
+
- semantic blocks give agents precise read and patch targets
|
|
32
36
|
|
|
33
|
-
|
|
34
|
-
# Install GRACE to your workspace
|
|
35
|
-
opkg install gh@osovv/grace-marketplace
|
|
37
|
+
This makes it easier to:
|
|
36
38
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
+
- plan modules and execution order
|
|
40
|
+
- hand work across agents without losing context
|
|
41
|
+
- review for drift between code, graph, and verification
|
|
42
|
+
- debug failures from named blocks and planned evidence
|
|
43
|
+
|
|
44
|
+
GRACE was designed by Vladimir Ivanov ([@turboplanner](https://t.me/turboplanner)).
|
|
45
|
+
|
|
46
|
+
## Install
|
|
47
|
+
|
|
48
|
+
Install **skills** first.
|
|
39
49
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
50
|
+
- Skills are the core GRACE product surface.
|
|
51
|
+
- The CLI is optional, but highly recommended once the skills are installed.
|
|
52
|
+
- Installing only skills is a valid setup.
|
|
53
|
+
- Installing only the CLI is usually not useful without the GRACE skills and workflow.
|
|
43
54
|
|
|
44
|
-
|
|
55
|
+
### Install Skills
|
|
56
|
+
|
|
57
|
+
Skills and CLI are complementary, but they are distributed differently.
|
|
58
|
+
|
|
59
|
+
#### OpenPackage
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
opkg install gh@osovv/grace-marketplace
|
|
63
|
+
opkg install gh@osovv/grace-marketplace -g
|
|
45
64
|
opkg install gh@osovv/grace-marketplace --platforms claude-code
|
|
46
|
-
opkg install gh@osovv/grace-marketplace --platforms cursor
|
|
47
|
-
opkg install gh@osovv/grace-marketplace --platforms opencode
|
|
48
65
|
```
|
|
49
66
|
|
|
50
|
-
|
|
67
|
+
#### Claude Code Marketplace
|
|
51
68
|
|
|
52
69
|
```bash
|
|
53
70
|
/plugin marketplace add osovv/grace-marketplace
|
|
54
71
|
/plugin install grace@grace-marketplace
|
|
55
72
|
```
|
|
56
73
|
|
|
57
|
-
|
|
74
|
+
#### Agent Skills-Compatible Install
|
|
58
75
|
|
|
59
76
|
```bash
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
npx skills add osovv/grace-marketplace -a claude-code
|
|
77
|
+
git clone https://github.com/osovv/grace-marketplace
|
|
78
|
+
cp -r grace-marketplace/skills/grace/grace-* /path/to/your/agent/skills/
|
|
63
79
|
```
|
|
64
80
|
|
|
65
|
-
|
|
81
|
+
### Install CLI
|
|
66
82
|
|
|
67
|
-
|
|
83
|
+
The CLI is a companion to the GRACE skills, not a replacement for them.
|
|
68
84
|
|
|
69
|
-
Requires `bun` on `PATH`.
|
|
85
|
+
Requires `bun` on `PATH`.
|
|
70
86
|
|
|
71
87
|
```bash
|
|
72
88
|
bun add -g @osovv/grace-cli
|
|
73
89
|
grace lint --path /path/to/grace-project
|
|
74
90
|
```
|
|
75
91
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
Inside Codex, use the built-in skill installer:
|
|
79
|
-
|
|
80
|
-
```text
|
|
81
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-init
|
|
82
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-plan
|
|
83
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-execute
|
|
84
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-multiagent-execute
|
|
85
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-refactor
|
|
86
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-setup-subagents
|
|
87
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-fix
|
|
88
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-refresh
|
|
89
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-status
|
|
90
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-ask
|
|
91
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-explainer
|
|
92
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-verification
|
|
93
|
-
$skill-installer install https://github.com/osovv/grace-marketplace/tree/main/skills/grace/grace-reviewer
|
|
94
|
-
```
|
|
92
|
+
## Quick Start
|
|
95
93
|
|
|
96
|
-
|
|
94
|
+
For a new GRACE project:
|
|
97
95
|
|
|
98
|
-
|
|
96
|
+
1. Run `$grace-init`
|
|
97
|
+
2. Design `docs/requirements.xml` and `docs/technology.xml` together with your agent
|
|
98
|
+
3. Run `$grace-plan`
|
|
99
|
+
4. Run `$grace-verification`
|
|
100
|
+
5. Run `$grace-execute` or `$grace-multiagent-execute`
|
|
99
101
|
|
|
100
|
-
|
|
102
|
+
For an existing GRACE project, the CLI is often the fastest way to orient yourself:
|
|
101
103
|
|
|
102
104
|
```bash
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
```
|
|
105
|
+
# Integrity gate
|
|
106
|
+
grace lint --path /path/to/project
|
|
106
107
|
|
|
107
|
-
|
|
108
|
+
# Resolve the relevant module
|
|
109
|
+
grace module find auth --path /path/to/project
|
|
110
|
+
grace module find src/provider/config-repo.ts --path /path/to/project --json
|
|
108
111
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
+
# Read shared/public context
|
|
113
|
+
grace module show M-AUTH --path /path/to/project
|
|
114
|
+
grace module show M-AUTH --path /path/to/project --with verification
|
|
115
|
+
|
|
116
|
+
# Read file-local/private context
|
|
117
|
+
grace file show src/auth/index.ts --path /path/to/project
|
|
118
|
+
grace file show src/auth/index.ts --path /path/to/project --contracts --blocks
|
|
112
119
|
```
|
|
113
120
|
|
|
114
|
-
##
|
|
121
|
+
## Skills Overview
|
|
122
|
+
|
|
123
|
+
| Skill | Purpose |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| `grace-init` | Bootstrap the GRACE docs, templates, and agent guidance |
|
|
126
|
+
| `grace-plan` | Design modules, phases, flows, dependencies, and contracts |
|
|
127
|
+
| `grace-verification` | Build and maintain `verification-plan.xml`, tests, traces, and log evidence |
|
|
128
|
+
| `grace-execute` | Execute the plan sequentially with scoped review and commits |
|
|
129
|
+
| `grace-multiagent-execute` | Execute parallel-safe waves with controller-managed synchronization |
|
|
130
|
+
| `grace-refactor` | Rename, move, split, merge, and extract modules without shared-artifact drift |
|
|
131
|
+
| `grace-fix` | Debug issues from graph, contracts, tests, traces, and semantic blocks |
|
|
132
|
+
| `grace-refresh` | Refresh graph and verification artifacts against the real codebase |
|
|
133
|
+
| `grace-reviewer` | Review semantic integrity, graph consistency, and verification quality |
|
|
134
|
+
| `grace-status` | Report overall project health and suggest the next safe action |
|
|
135
|
+
| `grace-ask` | Answer architecture and implementation questions from project artifacts |
|
|
136
|
+
| `grace-cli` | Use the optional `grace` binary as a fast lint and artifact-query layer for GRACE projects |
|
|
137
|
+
| `grace-explainer` | Explain the GRACE methodology itself |
|
|
138
|
+
| `grace-setup-subagents` | Scaffold shell-specific GRACE worker and reviewer presets |
|
|
115
139
|
|
|
116
|
-
|
|
117
|
-
# 1. Bootstrap GRACE docs and templates
|
|
118
|
-
/grace-init
|
|
140
|
+
## CLI Overview
|
|
119
141
|
|
|
120
|
-
|
|
142
|
+
| Command | What It Does |
|
|
143
|
+
| --- | --- |
|
|
144
|
+
| `grace lint --path <root>` | Validate current GRACE artifacts, semantic markup, unique XML tags, and export/map drift |
|
|
145
|
+
| `grace module find <query> --path <root>` | Search by module ID, name, path, purpose, annotations, dependency IDs, verification IDs, and `LINKS` |
|
|
146
|
+
| `grace module show <id-or-path> --path <root>` | Show the shared/public module record from plan, graph, steps, and linked files |
|
|
147
|
+
| `grace module show <id> --with verification --path <root>` | Include verification excerpt when a `V-M-*` entry exists |
|
|
148
|
+
| `grace file show <path> --path <root>` | Show file-local `MODULE_CONTRACT`, `MODULE_MAP`, and `CHANGE_SUMMARY` |
|
|
149
|
+
| `grace file show <path> --contracts --blocks --path <root>` | Include scoped contracts and semantic block navigation |
|
|
121
150
|
|
|
122
|
-
|
|
123
|
-
/grace-plan
|
|
151
|
+
Current output modes:
|
|
124
152
|
|
|
125
|
-
|
|
126
|
-
|
|
153
|
+
- `grace lint`: `text`, `json`
|
|
154
|
+
- `grace module find`: `table`, `json`
|
|
155
|
+
- `grace module show`: `text`, `json`
|
|
156
|
+
- `grace file show`: `text`, `json`
|
|
127
157
|
|
|
128
|
-
|
|
129
|
-
/grace-execute
|
|
158
|
+
## Public Shared Docs vs File-Local Markup
|
|
130
159
|
|
|
131
|
-
|
|
132
|
-
/grace-multiagent-execute
|
|
133
|
-
```
|
|
160
|
+
GRACE works best when shared docs stay public and stable, while private detail stays close to code.
|
|
134
161
|
|
|
135
|
-
|
|
162
|
+
Use shared XML artifacts for:
|
|
136
163
|
|
|
137
|
-
|
|
164
|
+
- module IDs and module boundaries
|
|
165
|
+
- public module contracts and public interfaces
|
|
166
|
+
- dependencies and execution order
|
|
167
|
+
- verification entries, commands, scenarios, and required markers
|
|
168
|
+
- project-level flows and phases
|
|
138
169
|
|
|
139
|
-
|
|
140
|
-
- `docs/technology.xml` - runtime, tooling, testing, observability, constraints
|
|
141
|
-
- `docs/development-plan.xml` - modules, contracts, flows, phases, execution ownership
|
|
142
|
-
- `docs/verification-plan.xml` - tests, traces, required log markers, and gates
|
|
143
|
-
- `docs/knowledge-graph.xml` - project navigation graph
|
|
144
|
-
- `docs/operational-packets.xml` - canonical execution packet, delta, and failure handoff templates
|
|
170
|
+
Use file-local markup for:
|
|
145
171
|
|
|
146
|
-
|
|
172
|
+
- `MODULE_CONTRACT`
|
|
173
|
+
- `MODULE_MAP`
|
|
174
|
+
- `CHANGE_SUMMARY`
|
|
175
|
+
- function and type contracts
|
|
176
|
+
- semantic block boundaries
|
|
177
|
+
- implementation-only helpers and orchestration details
|
|
147
178
|
|
|
148
|
-
|
|
149
|
-
|---|---|
|
|
150
|
-
| `grace-init` | Bootstrap GRACE docs, AGENTS, and XML templates |
|
|
151
|
-
| `grace-plan` | Architect modules, flows, knowledge graph, and verification refs |
|
|
152
|
-
| `grace-verification` | Design and maintain tests, traces, and log-driven evidence |
|
|
153
|
-
| `grace-execute` | Execute the full plan sequentially with scoped review and commits |
|
|
154
|
-
| `grace-multiagent-execute` | Execute independent modules in controller-managed parallel waves |
|
|
155
|
-
| `grace-refactor` | Refactor modules safely while keeping contracts, graph, and verification synchronized |
|
|
156
|
-
| `grace-setup-subagents` | Scaffold shell-specific GRACE worker and reviewer presets |
|
|
157
|
-
| `grace-fix` | Debug via semantic navigation, tests, and log markers |
|
|
158
|
-
| `grace-refresh` | Sync shared artifacts with the real codebase |
|
|
159
|
-
| `grace-status` | Project health report across docs, graph, and verification |
|
|
160
|
-
| `grace-ask` | Answer questions with full project context |
|
|
161
|
-
| `grace-explainer` | Complete GRACE methodology reference |
|
|
162
|
-
| `grace-reviewer` | Validate semantic markup, contracts, graph, and verification integrity |
|
|
179
|
+
Rule of thumb:
|
|
163
180
|
|
|
164
|
-
|
|
181
|
+
- `grace module show` is the shared/public truth
|
|
182
|
+
- `grace file show` is the file-local/private truth
|
|
165
183
|
|
|
166
|
-
|
|
167
|
-
|---|---|---|
|
|
168
|
-
| **Any (via OpenPackage)** | `opkg install` | OpenPackage (`openpackage.yml`) |
|
|
169
|
-
| **Claude Code** | `/plugin install` or `npx skills add` | Native plugin (`.claude-plugin/`) |
|
|
170
|
-
| **Codex CLI** | `$skill-installer` | Agent Skills (`skills/`) |
|
|
171
|
-
| **Kilo Code** | Copy to `~/.kilocode/skills/` | Agent Skills (`skills/`) |
|
|
172
|
-
| **Cursor, Windsurf, etc.** | `opkg install --platforms <name>` | OpenPackage (`openpackage.yml`) |
|
|
173
|
-
| **Other agents** | Copy to agent's skills directory | Agent Skills (`skills/`) |
|
|
184
|
+
## Core GRACE Artifacts
|
|
174
185
|
|
|
175
|
-
|
|
186
|
+
| Artifact | Role |
|
|
187
|
+
| --- | --- |
|
|
188
|
+
| `docs/requirements.xml` | Product intent, scope, use cases, and requirements |
|
|
189
|
+
| `docs/technology.xml` | Stack, tooling, constraints, runtime, and testing choices |
|
|
190
|
+
| `docs/development-plan.xml` | Modules, contracts, implementation order, phases, and flows |
|
|
191
|
+
| `docs/verification-plan.xml` | Verification entries, test commands, scenarios, and required markers |
|
|
192
|
+
| `docs/knowledge-graph.xml` | Module map, dependencies, public annotations, and navigation graph |
|
|
193
|
+
| `docs/operational-packets.xml` | Canonical execution packet, delta, and failure handoff templates |
|
|
194
|
+
| `src/**/*` and `tests/**/*` with GRACE markup | File-local module context, contracts, and semantic block boundaries |
|
|
176
195
|
|
|
177
|
-
##
|
|
196
|
+
## Typical Workflows
|
|
178
197
|
|
|
179
|
-
|
|
198
|
+
### Bootstrap a New Project
|
|
180
199
|
|
|
181
|
-
```
|
|
182
|
-
|
|
200
|
+
```text
|
|
201
|
+
$grace-init
|
|
202
|
+
design requirements.xml and technology.xml together with your agent
|
|
203
|
+
$grace-plan
|
|
204
|
+
$grace-verification
|
|
205
|
+
$grace-execute or $grace-multiagent-execute
|
|
183
206
|
```
|
|
184
207
|
|
|
185
|
-
|
|
208
|
+
### Inspect One Module Quickly
|
|
186
209
|
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
|
|
210
|
+
```text
|
|
211
|
+
grace module find <name-or-path>
|
|
212
|
+
grace module show M-XXX --with verification
|
|
213
|
+
grace file show <governed-file> --contracts --blocks
|
|
190
214
|
```
|
|
191
215
|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
```bash
|
|
195
|
-
# Search modules across shared docs and linked file-local markup
|
|
196
|
-
bun run grace module find auth --path /path/to/grace-project
|
|
197
|
-
bun run grace module find src/provider/config-repo.ts --path /path/to/grace-project --json
|
|
216
|
+
### Review or Refresh After Code Drift
|
|
198
217
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
# Show file-local/private markup
|
|
204
|
-
bun run grace file show src/provider/config-repo.ts --path /path/to/grace-project
|
|
205
|
-
bun run grace file show src/provider/config-repo.ts --path /path/to/grace-project --contracts --blocks
|
|
218
|
+
```text
|
|
219
|
+
grace lint --path <project-root>
|
|
220
|
+
$grace-reviewer
|
|
221
|
+
$grace-refresh
|
|
206
222
|
```
|
|
207
223
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
- structural checks stay language-agnostic
|
|
211
|
-
- export-map parity uses language adapters where available
|
|
212
|
-
- file behavior is driven by semantic roles instead of filename masks
|
|
224
|
+
### Debug a Failing Flow
|
|
213
225
|
|
|
214
|
-
|
|
226
|
+
```text
|
|
227
|
+
grace module find <error-or-path>
|
|
228
|
+
grace module show M-XXX --with verification
|
|
229
|
+
grace file show <governed-file> --contracts --blocks
|
|
230
|
+
$grace-fix
|
|
231
|
+
```
|
|
215
232
|
|
|
216
|
-
|
|
217
|
-
- Python via the Python standard-library AST, without `pyright`
|
|
233
|
+
## Repository Layout
|
|
218
234
|
|
|
219
|
-
|
|
235
|
+
| Path | Purpose |
|
|
236
|
+
| --- | --- |
|
|
237
|
+
| `skills/grace/*` | Canonical skill sources |
|
|
238
|
+
| `plugins/grace/skills/grace/*` | Packaged mirror used for marketplace distribution |
|
|
239
|
+
| `.claude-plugin/marketplace.json` | Marketplace entry and published skill set |
|
|
240
|
+
| `plugins/grace/.claude-plugin/plugin.json` | Packaged plugin manifest |
|
|
241
|
+
| `src/grace.ts` | CLI entrypoint |
|
|
242
|
+
| `src/grace-lint.ts` | `grace lint` command |
|
|
243
|
+
| `src/grace-module.ts` | `grace module find/show` commands |
|
|
244
|
+
| `src/grace-file.ts` | `grace file show` command |
|
|
245
|
+
| `src/query/*` | Artifact loader, index, and render layer for CLI queries |
|
|
246
|
+
| `scripts/validate-marketplace.ts` | Packaging and release validation |
|
|
220
247
|
|
|
221
|
-
|
|
222
|
-
- Python export analysis is exact when `__all__` is explicit, otherwise heuristic
|
|
223
|
-
- other languages still benefit from structural GRACE checks even when rich export analysis is not available yet
|
|
248
|
+
## For Maintainers
|
|
224
249
|
|
|
225
|
-
|
|
250
|
+
- Treat `skills/grace/*` as the source of truth unless the task is explicitly about packaged output.
|
|
251
|
+
- Keep `plugins/grace/skills/grace/*` synchronized with the canonical skill files.
|
|
252
|
+
- Keep versions synchronized across `README.md`, `package.json`, `openpackage.yml`, `.claude-plugin/marketplace.json`, and `plugins/grace/.claude-plugin/plugin.json`.
|
|
253
|
+
- Validate packaging changes with `bun run ./scripts/validate-marketplace.ts`.
|
|
254
|
+
- Validate CLI changes with `bun run ./src/grace.ts lint --path . --allow-missing-docs` and `bun test`.
|
|
255
|
+
- Do not assume every directory under `skills/grace/` is published; the actual shipped set is declared in `.claude-plugin/marketplace.json`.
|
|
226
256
|
|
|
227
|
-
|
|
228
|
-
- `grace file show` reads file-local/private `MODULE_CONTRACT`, `MODULE_MAP`, `CHANGE_SUMMARY`, scoped contracts, and semantic blocks.
|
|
229
|
-
- `grace module find` searches both planes, including shared docs and linked file-local paths via `LINKS`.
|
|
257
|
+
## Development and Validation
|
|
230
258
|
|
|
231
|
-
|
|
259
|
+
Install dependencies:
|
|
232
260
|
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
MAP_MODE: EXPORTS | LOCALS | SUMMARY | NONE
|
|
261
|
+
```bash
|
|
262
|
+
bun install
|
|
236
263
|
```
|
|
237
264
|
|
|
238
|
-
|
|
265
|
+
Run the test suite:
|
|
239
266
|
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
- `CONFIG` => export parity is skipped by default
|
|
244
|
-
- `TYPES` => type export surfaces are checked when the adapter supports them
|
|
245
|
-
- `SCRIPT` => `MODULE_MAP` describes important local entry points and helpers instead of exports
|
|
267
|
+
```bash
|
|
268
|
+
bun test
|
|
269
|
+
```
|
|
246
270
|
|
|
247
|
-
|
|
271
|
+
Run the CLI against the repository itself:
|
|
248
272
|
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
"ignoredDirs": ["tmp"]
|
|
252
|
-
}
|
|
273
|
+
```bash
|
|
274
|
+
bun run ./src/grace.ts lint --path . --allow-missing-docs
|
|
253
275
|
```
|
|
254
276
|
|
|
255
|
-
|
|
277
|
+
Run marketplace and packaging validation:
|
|
256
278
|
|
|
257
|
-
|
|
279
|
+
```bash
|
|
280
|
+
bun run ./scripts/validate-marketplace.ts
|
|
281
|
+
```
|
|
258
282
|
|
|
259
|
-
|
|
283
|
+
Smoke test the query layer against a real GRACE project:
|
|
260
284
|
|
|
261
|
-
|
|
285
|
+
```bash
|
|
286
|
+
bun run ./src/grace.ts module show M-AUTH --path /path/to/grace-project --with verification
|
|
287
|
+
bun run ./src/grace.ts file show src/auth/index.ts --path /path/to/grace-project --contracts --blocks
|
|
288
|
+
```
|
|
262
289
|
|
|
263
290
|
## License
|
|
264
291
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osovv/grace-cli",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.7.0",
|
|
4
4
|
"description": "GRACE CLI for linting semantic markup, contracts, and querying GRACE artifacts with a Bun-powered grace binary.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/osovv/grace-marketplace#readme",
|
package/src/grace.ts
CHANGED
|
@@ -9,7 +9,7 @@ import { moduleCommand } from "./grace-module";
|
|
|
9
9
|
const main = defineCommand({
|
|
10
10
|
meta: {
|
|
11
11
|
name: "grace",
|
|
12
|
-
version: "3.
|
|
12
|
+
version: "3.7.0",
|
|
13
13
|
description: "GRACE CLI for linting semantic markup and querying GRACE project artifacts.",
|
|
14
14
|
},
|
|
15
15
|
subCommands: {
|