renma 0.15.0 → 0.15.1
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/CHANGELOG.md +14 -1
- package/README.md +1 -1
- package/dist/cli-help.d.ts +293 -0
- package/dist/cli-help.d.ts.map +1 -0
- package/dist/cli-help.js +714 -0
- package/dist/cli-help.js.map +1 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +38 -120
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,18 @@ This project follows the spirit of [Keep a Changelog](https://keepachangelog.com
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [0.15.1] - 2026-07-10
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- Added command-specific CLI help for every command, including purpose, use cases, boundaries, examples, next steps, and relevant options for human and coding-agent workflows.
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
|
|
17
|
+
- Expanded top-level CLI help with Renma's deterministic governance boundaries, start-here workflows, and command-selection questions.
|
|
18
|
+
- Clarified command-specific option help with accepted output formats, defaults, owner behavior, scaffold output modes, and BOM timestamp/path boundaries.
|
|
19
|
+
- Improved CLI usage errors to point to the relevant command help page where applicable.
|
|
20
|
+
|
|
9
21
|
## [0.15.0] - 2026-07-09
|
|
10
22
|
|
|
11
23
|
### Added
|
|
@@ -267,7 +279,8 @@ Tag-only release. No GitHub Release entry was published for this version.
|
|
|
267
279
|
- Added metadata governance, advisory diagnostics, local path checks, and semantic split suggestions.
|
|
268
280
|
- Added the initial project documentation, architecture notes, package metadata, tests, and license.
|
|
269
281
|
|
|
270
|
-
[Unreleased]: https://github.com/KazuCocoa/renma/compare/v0.15.
|
|
282
|
+
[Unreleased]: https://github.com/KazuCocoa/renma/compare/v0.15.1...HEAD
|
|
283
|
+
[0.15.1]: https://github.com/KazuCocoa/renma/compare/v0.15.0...v0.15.1
|
|
271
284
|
[0.15.0]: https://github.com/KazuCocoa/renma/compare/v0.14.1...v0.15.0
|
|
272
285
|
[0.14.1]: https://github.com/KazuCocoa/renma/compare/v0.14.0...v0.14.1
|
|
273
286
|
[0.14.0]: https://github.com/KazuCocoa/renma/compare/v0.13.2...v0.14.0
|
package/README.md
CHANGED
|
@@ -264,7 +264,7 @@ npx renma diff . --from main --to HEAD --format markdown
|
|
|
264
264
|
|
|
265
265
|
The first command does not require you to design a knowledge architecture up front. It scans the repository, builds a local catalog, and reports obvious health issues such as broken links, unclear ownership, risky instructions, weak structure, and context that may be hard for agents to trust.
|
|
266
266
|
|
|
267
|
-
For guided workflows, see the User Manual sections on [creating a new skill with scaffold](docs/user-manual.md#user-story-create-a-new-skill-with-scaffold) and [improving existing skills with diagnostics](docs/user-manual.md#user-story-improve-existing-skills-with-diagnostics).
|
|
267
|
+
Command-specific help is designed for both humans and coding agents: start with `renma --help`, then run `renma <command> --help` before choosing a workflow. For guided workflows, see the User Manual sections on [LLM-assisted skill maintenance](docs/user-manual.md#llm-assisted-skill-maintenance), [creating a new skill with scaffold](docs/user-manual.md#user-story-create-a-new-skill-with-scaffold), and [improving existing skills with diagnostics](docs/user-manual.md#user-story-improve-existing-skills-with-diagnostics).
|
|
268
268
|
|
|
269
269
|
If you are developing Renma from source:
|
|
270
270
|
|
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
export interface CommandHelp {
|
|
2
|
+
name: string;
|
|
3
|
+
usage: string;
|
|
4
|
+
question: string;
|
|
5
|
+
purpose: string;
|
|
6
|
+
useWhen: readonly string[];
|
|
7
|
+
doNotUseFor: readonly string[];
|
|
8
|
+
examples: readonly string[];
|
|
9
|
+
interpretation: readonly string[];
|
|
10
|
+
nextSteps: readonly string[];
|
|
11
|
+
options: readonly CommandOptionHelp[];
|
|
12
|
+
}
|
|
13
|
+
export type CommandOptionHelp = CliOptionName | {
|
|
14
|
+
name: CliOptionName;
|
|
15
|
+
description?: string;
|
|
16
|
+
};
|
|
17
|
+
declare const OPTION_HELP: {
|
|
18
|
+
readonly config: {
|
|
19
|
+
readonly flags: "-c, --config <path>";
|
|
20
|
+
readonly description: "Read Renma JSON config from path.";
|
|
21
|
+
};
|
|
22
|
+
readonly "fail-on": {
|
|
23
|
+
readonly flags: "--fail-on <level>";
|
|
24
|
+
readonly description: "Exit 1 when scan findings meet severity: low, medium, high, or critical.";
|
|
25
|
+
};
|
|
26
|
+
readonly focus: {
|
|
27
|
+
readonly flags: "--focus <asset-id-or-path>";
|
|
28
|
+
readonly description: "Keep one matched asset and its one-hop graph neighborhood.";
|
|
29
|
+
};
|
|
30
|
+
readonly format: {
|
|
31
|
+
readonly flags: "--format <format>";
|
|
32
|
+
readonly description: "Output format for commands that accept --format.";
|
|
33
|
+
};
|
|
34
|
+
readonly from: {
|
|
35
|
+
readonly flags: "--from <ref>";
|
|
36
|
+
readonly description: "Git ref to use as the comparison baseline.";
|
|
37
|
+
};
|
|
38
|
+
readonly help: {
|
|
39
|
+
readonly flags: "-h, --help";
|
|
40
|
+
readonly description: "Show this help page without running the command.";
|
|
41
|
+
};
|
|
42
|
+
readonly "include-owned": {
|
|
43
|
+
readonly flags: "--include-owned";
|
|
44
|
+
readonly description: "Include flat owned asset details in ownership output.";
|
|
45
|
+
};
|
|
46
|
+
readonly id: {
|
|
47
|
+
readonly flags: "--id <id>";
|
|
48
|
+
readonly description: "Set the scaffolded asset ID instead of deriving one.";
|
|
49
|
+
};
|
|
50
|
+
readonly json: {
|
|
51
|
+
readonly flags: "--json";
|
|
52
|
+
readonly description: "Shortcut for --format json where JSON is supported.";
|
|
53
|
+
};
|
|
54
|
+
readonly lines: {
|
|
55
|
+
readonly flags: "--lines <range>";
|
|
56
|
+
readonly description: "Print an exact line range such as L10-L42 or 10-42.";
|
|
57
|
+
};
|
|
58
|
+
readonly "max-context-bytes": {
|
|
59
|
+
readonly flags: "--max-context-bytes <n>";
|
|
60
|
+
readonly description: "Limit nearby context bytes for semantic split suggestions.";
|
|
61
|
+
};
|
|
62
|
+
readonly "max-source-bytes": {
|
|
63
|
+
readonly flags: "--max-source-bytes <n>";
|
|
64
|
+
readonly description: "Limit source file bytes for semantic split suggestions.";
|
|
65
|
+
};
|
|
66
|
+
readonly "omit-generated-at": {
|
|
67
|
+
readonly flags: "--omit-generated-at";
|
|
68
|
+
readonly description: "Omit the BOM run-time generatedAt timestamp.";
|
|
69
|
+
};
|
|
70
|
+
readonly owner: {
|
|
71
|
+
readonly flags: "--owner <owner>";
|
|
72
|
+
readonly description: "Owner value for commands that accept --owner.";
|
|
73
|
+
};
|
|
74
|
+
readonly tags: {
|
|
75
|
+
readonly flags: "--tags <tags>";
|
|
76
|
+
readonly description: "Set comma-separated or repeated scaffold tags.";
|
|
77
|
+
};
|
|
78
|
+
readonly title: {
|
|
79
|
+
readonly flags: "--title <title>";
|
|
80
|
+
readonly description: "Set scaffold title metadata.";
|
|
81
|
+
};
|
|
82
|
+
readonly to: {
|
|
83
|
+
readonly flags: "--to <ref>";
|
|
84
|
+
readonly description: "Git ref to use as the comparison target.";
|
|
85
|
+
};
|
|
86
|
+
readonly version: {
|
|
87
|
+
readonly flags: "-v, --version";
|
|
88
|
+
readonly description: "Print the Renma package version.";
|
|
89
|
+
};
|
|
90
|
+
readonly view: {
|
|
91
|
+
readonly flags: "--view <view>";
|
|
92
|
+
readonly description: "Graph view: summary, workflow, full, layered, or lens.";
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
export type CliOptionName = keyof typeof OPTION_HELP;
|
|
96
|
+
export declare const COMMAND_HELP: readonly [{
|
|
97
|
+
readonly name: "scan";
|
|
98
|
+
readonly usage: "renma scan [path] [options]";
|
|
99
|
+
readonly question: "What concrete problems should be fixed?";
|
|
100
|
+
readonly purpose: "Scan is usually the first command when improving existing skills or context assets. It reports concrete findings and deterministic diagnostics without editing files.";
|
|
101
|
+
readonly useWhen: readonly ["You need the first actionable view of repository problems.", "You are preparing or verifying a patch for skills, contexts, prompts, or agent-facing docs.", "A downstream tool or coding agent needs JSON guidance, repair constraints, and verification steps."];
|
|
102
|
+
readonly doNotUseFor: readonly ["Automatically rewriting files or applying fixes.", "An agent inventing owners, references, source-of-truth documents, or product rules.", "Selecting runtime context for an LLM or assembling task prompts."];
|
|
103
|
+
readonly examples: readonly ["renma scan .", "renma scan . --format json", "renma scan . --fail-on high"];
|
|
104
|
+
readonly interpretation: readonly ["Text output is a human-readable finding list.", "JSON output includes structured diagnostics, review bundles, and guidance intended for downstream tools and coding agents.", "When repair constraints or verification steps are present, follow them instead of broadening the edit."];
|
|
105
|
+
readonly nextSteps: readonly ["Inspect evidence before editing.", "Prepare a minimal reviewable patch that preserves supported semantics.", "Rerun scan and any relevant structural commands after editing."];
|
|
106
|
+
readonly options: readonly ["config", "fail-on", {
|
|
107
|
+
readonly name: "format";
|
|
108
|
+
readonly description: "Output format: text or json. Defaults to text.";
|
|
109
|
+
}, "json", "help"];
|
|
110
|
+
}, {
|
|
111
|
+
readonly name: "catalog";
|
|
112
|
+
readonly usage: "renma catalog [path] [options]";
|
|
113
|
+
readonly question: "What assets and metadata exist?";
|
|
114
|
+
readonly purpose: "Catalog inventories discovered assets and normalized metadata so reviewers can see the repository evidence Renma found.";
|
|
115
|
+
readonly useWhen: readonly ["You need IDs, kinds, owners, lifecycle states, hashes, tags, declared dependencies, or context relationships.", "You want inventory evidence before changing metadata or references.", "You need stable JSON or Markdown asset inventory for review."];
|
|
116
|
+
readonly doNotUseFor: readonly ["Treating inventory as a problem list by itself.", "Deciding what context an agent should consume at runtime.", "Proving that a declared dependency is semantically correct."];
|
|
117
|
+
readonly examples: readonly ["renma catalog . --format markdown", "renma catalog . --format json"];
|
|
118
|
+
readonly interpretation: readonly ["Catalog output is deterministic inventory evidence.", "Missing, duplicate, or unresolved metadata may appear as diagnostics, but catalog is not a substitute for scan.", "Dependencies are declared relationships discovered from repository metadata and references."];
|
|
119
|
+
readonly nextSteps: readonly ["Run graph to inspect relationships.", "Run readiness for repository-level summary.", "Run scan for concrete findings to fix."];
|
|
120
|
+
readonly options: readonly ["config", {
|
|
121
|
+
readonly name: "format";
|
|
122
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
123
|
+
}, "json", "help"];
|
|
124
|
+
}, {
|
|
125
|
+
readonly name: "graph";
|
|
126
|
+
readonly usage: "renma graph [path] [options]";
|
|
127
|
+
readonly question: "How are assets structurally connected?";
|
|
128
|
+
readonly purpose: "Graph shows declared structural relationships between assets, including focused views around one asset.";
|
|
129
|
+
readonly useWhen: readonly ["You need to inspect dependencies, references, unresolved targets, or isolation.", "You want a one-hop neighborhood with --focus for one asset ID or path.", "You need Markdown, JSON, or Mermaid evidence for review."];
|
|
130
|
+
readonly doNotUseFor: readonly ["It does not select context for an LLM.", "It does not prove that a dependency is semantically correct.", "Deleting isolated assets without human review."];
|
|
131
|
+
readonly examples: readonly ["renma graph . --format markdown", "renma graph . --view layered --format mermaid", "renma graph . --focus contexts/testing/boundary-value-analysis.md --view full"];
|
|
132
|
+
readonly interpretation: readonly ["Edges represent declared relationships Renma can resolve or report as unresolved.", "Unexpected isolation is evidence to review, not automatic permission to delete an asset.", "Focused output filters to the matched asset and directly connected neighbors."];
|
|
133
|
+
readonly nextSteps: readonly ["Use catalog to inspect the assets behind graph nodes.", "Use scan to fix concrete relationship findings.", "Rerun graph after metadata or reference changes."];
|
|
134
|
+
readonly options: readonly ["config", {
|
|
135
|
+
readonly name: "format";
|
|
136
|
+
readonly description: "Output format: json, markdown, or mermaid. Defaults to json. JSON defaults to the full view; non-JSON formats default to the summary view.";
|
|
137
|
+
}, "json", "view", "focus", "help"];
|
|
138
|
+
}, {
|
|
139
|
+
readonly name: "trust-graph";
|
|
140
|
+
readonly usage: "renma trust-graph [path] [options]";
|
|
141
|
+
readonly question: "What trust-relevant evidence is connected to each asset?";
|
|
142
|
+
readonly purpose: "Trust graph connects deterministic evidence such as ownership, lifecycle, policy, references, dependencies, and diagnostics.";
|
|
143
|
+
readonly useWhen: readonly ["A reviewer or downstream tool needs traceable trust-relevant evidence per asset.", "You need to connect owners, lifecycle status, effective policy fingerprints, dependencies, and diagnostics.", "You want a stable evidence layer for human review."];
|
|
144
|
+
readonly doNotUseFor: readonly ["It is not a subjective trust score.", "It does not certify that an asset is trustworthy.", "Runtime policy enforcement, prompt assembly, or telemetry."];
|
|
145
|
+
readonly examples: readonly ["renma trust-graph . --format markdown", "renma trust-graph . --format json"];
|
|
146
|
+
readonly interpretation: readonly ["The report connects evidence; it does not decide trust for you.", "Missing owner, lifecycle, policy, or diagnostic evidence should be reviewed in context.", "JSON is the source of truth for downstream tooling; Markdown is for human review."];
|
|
147
|
+
readonly nextSteps: readonly ["Use scan for concrete diagnostics.", "Use ownership when owner coverage needs deeper review.", "Use readiness for repository-level summary."];
|
|
148
|
+
readonly options: readonly ["config", {
|
|
149
|
+
readonly name: "format";
|
|
150
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
151
|
+
}, "json", "help"];
|
|
152
|
+
}, {
|
|
153
|
+
readonly name: "readiness";
|
|
154
|
+
readonly usage: "renma readiness [path] [options]";
|
|
155
|
+
readonly question: "Is the repository broadly prepared for agent-facing use?";
|
|
156
|
+
readonly purpose: "Readiness provides a repository-level scorecard and health summary derived from deterministic repository evidence.";
|
|
157
|
+
readonly useWhen: readonly ["You need a broad maintainer or CI summary after scan, catalog, or graph review.", "You want repository-level checks for ownership, graph resolution, lifecycle, context lens governance, and selected findings.", "You need Markdown for review or JSON for automation."];
|
|
158
|
+
readonly doNotUseFor: readonly ["Replacing scan when you need concrete findings.", "Deciding whether an agent should consume a particular context asset at runtime.", "Claiming what an LLM actually used."];
|
|
159
|
+
readonly examples: readonly ["renma readiness . --format markdown", "renma readiness . --format json"];
|
|
160
|
+
readonly interpretation: readonly ["Scan gives concrete findings; readiness gives a broad repository summary.", "Readiness scores and checks are static repository review signals.", "Security posture and context lens summaries remain deterministic evidence, not runtime decisions."];
|
|
161
|
+
readonly nextSteps: readonly ["Use scan to fix specific findings behind readiness failures.", "Use catalog and graph to inspect inventory or relationship causes.", "Rerun readiness after the patch."];
|
|
162
|
+
readonly options: readonly ["config", {
|
|
163
|
+
readonly name: "format";
|
|
164
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
165
|
+
}, "json", "help"];
|
|
166
|
+
}, {
|
|
167
|
+
readonly name: "bom";
|
|
168
|
+
readonly usage: "renma bom [path] [options]";
|
|
169
|
+
readonly question: "What declared repository context manifest should be reviewed?";
|
|
170
|
+
readonly purpose: "BOM prints a declared repository evidence snapshot combining catalog, graph, lifecycle, hashes, diagnostics, readiness, and security posture evidence.";
|
|
171
|
+
readonly useWhen: readonly ["Reviewers or CI consumers need one manifest of declared repository context evidence.", "You need a PR artifact that combines inventory, dependencies, diagnostics, readiness, lifecycle, hashes, and security posture.", "You need structured JSON generated from deterministic repository evidence or compact Markdown for review."];
|
|
172
|
+
readonly doNotUseFor: readonly ["Reporting what an LLM actually consumed.", "It is not telemetry, prompt assembly, runtime context selection, or agent execution.", "Normalizing every repository or environment-dependent metadata value."];
|
|
173
|
+
readonly examples: readonly ["renma bom . --format json", "renma bom . --format markdown", "renma bom . --format json --omit-generated-at"];
|
|
174
|
+
readonly interpretation: readonly ["The BOM is a declared repository manifest, not a runtime usage report or telemetry.", "--omit-generated-at only removes the run-time generation timestamp.", "The option does not normalize repository metadata timestamps such as lastReviewedAt or expiresAt, and it does not normalize all environment-dependent paths such as root or configPath."];
|
|
175
|
+
readonly nextSteps: readonly ["Review diagnostics and readiness sections before merging.", "Use scan, catalog, or graph for focused follow-up.", "Store JSON when automation needs the source of truth."];
|
|
176
|
+
readonly options: readonly ["config", {
|
|
177
|
+
readonly name: "format";
|
|
178
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
179
|
+
}, "json", "omit-generated-at", "help"];
|
|
180
|
+
}, {
|
|
181
|
+
readonly name: "ownership";
|
|
182
|
+
readonly usage: "renma ownership [path] [options]";
|
|
183
|
+
readonly question: "Where is ownership missing or concentrated?";
|
|
184
|
+
readonly purpose: "Ownership helps review owner coverage, unowned assets, and concentration by declared owner.";
|
|
185
|
+
readonly useWhen: readonly ["You need to find assets without owner metadata.", "You want to review what one owner is responsible for.", "You need ownership coverage evidence for governance review."];
|
|
186
|
+
readonly doNotUseFor: readonly ["Renma should not invent or assign an owner from paths, prose, Git history, or guesses.", "Replacing human or source-of-truth confirmation for missing ownership.", "Treating unowned assets as automatic failures in every repository."];
|
|
187
|
+
readonly examples: readonly ["renma ownership . --format markdown", "renma ownership . --include-owned", "renma ownership . --owner qa-platform --format json"];
|
|
188
|
+
readonly interpretation: readonly ["Ownership output reports declared owner metadata and coverage.", "Missing ownership normally requires confirmation from a human or an existing source of truth.", "Owner filters keep repository-level totals while adding owner-specific details."];
|
|
189
|
+
readonly nextSteps: readonly ["Confirm missing owners before editing metadata.", "Use suggest-metadata when preparing a metadata-only retrofit.", "Rerun ownership and scan after ownership changes."];
|
|
190
|
+
readonly options: readonly ["config", {
|
|
191
|
+
readonly name: "format";
|
|
192
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
193
|
+
}, "json", "include-owned", {
|
|
194
|
+
readonly name: "owner";
|
|
195
|
+
readonly description: "Show owner-specific declared asset details while preserving repository-level coverage totals.";
|
|
196
|
+
}, "help"];
|
|
197
|
+
}, {
|
|
198
|
+
readonly name: "diff";
|
|
199
|
+
readonly usage: "renma diff [path] --from <ref> --to <ref> [options]";
|
|
200
|
+
readonly question: "What deterministic readiness evidence changed between refs?";
|
|
201
|
+
readonly purpose: "Diff compares deterministic repository evidence between Git refs for context and skill review.";
|
|
202
|
+
readonly useWhen: readonly ["You need to review readiness, asset, graph, check, or finding changes before merging.", "A pull request changes skills, contexts, metadata, or agent-facing docs.", "You want JSON or Markdown evidence over repository governance changes."];
|
|
203
|
+
readonly doNotUseFor: readonly ["A generic source-code diff.", "Determining what an LLM consumed at runtime.", "Replacing human review of semantic changes."];
|
|
204
|
+
readonly examples: readonly ["renma diff . --from main --to HEAD", "renma diff . --from origin/main --to HEAD --format markdown"];
|
|
205
|
+
readonly interpretation: readonly ["The report compares Renma evidence generated at two refs.", "Added or removed findings show deterministic review signal changes, not arbitrary source hunks.", "Usage errors exit 2; generated comparison output follows command status rules."];
|
|
206
|
+
readonly nextSteps: readonly ["Use ci-report when a PR-oriented summary is needed.", "Use scan or graph on the working tree to investigate changed evidence.", "Summarize changed evidence and remaining uncertainty for reviewers."];
|
|
207
|
+
readonly options: readonly ["config", "from", "to", {
|
|
208
|
+
readonly name: "format";
|
|
209
|
+
readonly description: "Output format: json or markdown. Defaults to json.";
|
|
210
|
+
}, "json", "help"];
|
|
211
|
+
}, {
|
|
212
|
+
readonly name: "ci-report";
|
|
213
|
+
readonly usage: "renma ci-report [path] --from <ref> --to <ref> [options]";
|
|
214
|
+
readonly question: "What should a CI or PR reviewer inspect?";
|
|
215
|
+
readonly purpose: "CI report produces a pull-request-oriented summary from deterministic Renma evidence.";
|
|
216
|
+
readonly useWhen: readonly ["CI needs a PASS, WARN, or FAIL status with review-focused details.", "A PR reviewer needs readiness, graph, and finding changes summarized.", "You want Markdown for a PR comment or JSON for automation."];
|
|
217
|
+
readonly doNotUseFor: readonly ["Replacing human review.", "A full generic code diff.", "Certifying that all semantic changes are correct."];
|
|
218
|
+
readonly examples: readonly ["renma ci-report . --from main --to HEAD --format markdown", "renma ci-report . --from origin/main --to HEAD --format json"];
|
|
219
|
+
readonly interpretation: readonly ["The report combines deterministic evidence for review.", "PASS and WARN exit 0; FAIL exits 1; usage errors exit 2.", "Reviewers should still inspect meaningful semantic changes."];
|
|
220
|
+
readonly nextSteps: readonly ["Fix or explain new failures and warnings.", "Use diff for the underlying evidence comparison.", "Rerun ci-report after updating the branch."];
|
|
221
|
+
readonly options: readonly ["config", "from", "to", {
|
|
222
|
+
readonly name: "format";
|
|
223
|
+
readonly description: "Output format: json or markdown. Defaults to markdown.";
|
|
224
|
+
}, "json", "help"];
|
|
225
|
+
}, {
|
|
226
|
+
readonly name: "inspect";
|
|
227
|
+
readonly usage: "renma inspect <file> [options]";
|
|
228
|
+
readonly question: "What is the outline or exact line slice of one file?";
|
|
229
|
+
readonly purpose: "Inspect provides a compact outline or exact line slice of a single file.";
|
|
230
|
+
readonly useWhen: readonly ["You need to inspect one asset before editing without reading the whole repository.", "A coding agent needs a deterministic outline or exact line range.", "You want Context Lens or relationship hints for one file when repository context can be inferred."];
|
|
231
|
+
readonly doNotUseFor: readonly ["Selecting runtime context for an LLM.", "Assembling prompts for task execution.", "Replacing scan, catalog, or graph for repository-wide evidence."];
|
|
232
|
+
readonly examples: readonly ["renma inspect skills/testing/spec-review/SKILL.md", "renma inspect skills/testing/spec-review/SKILL.md --lines L10-L42", "renma inspect contexts/testing/boundary-value-analysis.md --format json"];
|
|
233
|
+
readonly interpretation: readonly ["Without --lines, output is a structured outline of one file.", "With --lines, output is an exact source slice.", "Inspect is an inspection helper, not a runtime context selector or prompt assembler."];
|
|
234
|
+
readonly nextSteps: readonly ["Use scan for concrete findings before or after edits.", "Use catalog or graph if one-file inspection reveals relationship questions.", "Cite exact lines when summarizing edits for review."];
|
|
235
|
+
readonly options: readonly [{
|
|
236
|
+
readonly name: "format";
|
|
237
|
+
readonly description: "Output format: text or json. Defaults to json.";
|
|
238
|
+
}, "json", "lines", "help"];
|
|
239
|
+
}, {
|
|
240
|
+
readonly name: "scaffold";
|
|
241
|
+
readonly usage: "renma scaffold <skill|context|context_lens> <path> [options]";
|
|
242
|
+
readonly question: "How can a new asset start from a deterministic structure?";
|
|
243
|
+
readonly purpose: "Scaffold creates deterministic starter structures or authoring prompts for new Renma assets.";
|
|
244
|
+
readonly useWhen: readonly ["You are creating a new skill, context asset, or context lens.", "You want a starter file or prompt with expected metadata and sections.", "You need a deterministic starting point before authoring content."];
|
|
245
|
+
readonly doNotUseFor: readonly ["Generating a complete production-ready skill or context.", "Inventing domain knowledge merely to fill the template.", "Replacing author-provided purpose, routing boundaries, inputs, completion criteria, verification, or references."];
|
|
246
|
+
readonly examples: readonly ["renma scaffold skill skills/testing/spec-review/SKILL.md --owner qa-platform", "renma scaffold context contexts/testing/boundary-value-analysis.md --owner qa-platform", "renma scaffold context_lens lenses/testing/spec-review-boundary-values.md --owner qa-platform", "renma scaffold skill skills/testing/spec-review/SKILL.md --owner qa-platform --format prompt"];
|
|
247
|
+
readonly interpretation: readonly ["File mode creates the scaffold file at the target path and refuses to overwrite existing files.", "Prompt and JSON modes print to stdout instead of creating the scaffold file.", "Generated scaffold content is a starting structure, not a complete asset.", "The author must still provide purpose, routing boundaries, inputs, completion criteria, verification, and references.", "Domain knowledge must come from evidence or human input."];
|
|
248
|
+
readonly nextSteps: readonly ["Edit the generated content with evidence-backed details.", "Run scan, catalog, graph, and readiness after editing.", "Have a human review meaningful semantic content before merging."];
|
|
249
|
+
readonly options: readonly [{
|
|
250
|
+
readonly name: "format";
|
|
251
|
+
readonly description: "Output format: file, prompt, or json. Defaults to file. File mode writes the scaffold to the target path and requires --owner. Prompt and JSON modes print to stdout instead of creating the target file.";
|
|
252
|
+
}, {
|
|
253
|
+
readonly name: "owner";
|
|
254
|
+
readonly description: "Set owner metadata on the scaffold. Required when --format file is used.";
|
|
255
|
+
}, "id", "title", "tags", "help"];
|
|
256
|
+
}, {
|
|
257
|
+
readonly name: "suggest-metadata";
|
|
258
|
+
readonly usage: "renma suggest-metadata <file> [options]";
|
|
259
|
+
readonly question: "How can a coding agent prepare a metadata-only retrofit?";
|
|
260
|
+
readonly purpose: "Suggest metadata emits a prompt or structured suggestion for a metadata-focused retrofit of one existing asset.";
|
|
261
|
+
readonly useWhen: readonly ["An asset lacks compact metadata and you want a reviewable metadata patch.", "You need guidance that preserves the existing Markdown body and semantics.", "A human explicitly provides an owner with --owner or the asset already declares one."];
|
|
262
|
+
readonly doNotUseFor: readonly ["Editing the file automatically.", "Changing the Markdown body or asset semantics unless explicitly requested.", "Inferring an owner without evidence."];
|
|
263
|
+
readonly examples: readonly ["renma suggest-metadata skills/testing/spec-review/SKILL.md --format prompt", "renma suggest-metadata skills/testing/spec-review/SKILL.md --owner qa-platform --format json"];
|
|
264
|
+
readonly interpretation: readonly ["The command prints to stdout and does not edit the target file.", "Without --owner, do not add owner metadata unless the asset already declares one or a maintainer confirms it.", "Preserve existing Markdown body and semantics for a metadata-only retrofit."];
|
|
265
|
+
readonly nextSteps: readonly ["Apply only evidence-backed metadata changes in a reviewable patch.", "Run scan and ownership after editing.", "Report any missing owner, reference, or source-of-truth uncertainty."];
|
|
266
|
+
readonly options: readonly [{
|
|
267
|
+
readonly name: "format";
|
|
268
|
+
readonly description: "Output format: prompt or json. Defaults to prompt. The command prints to stdout and does not edit the target file.";
|
|
269
|
+
}, "json", {
|
|
270
|
+
readonly name: "owner";
|
|
271
|
+
readonly description: "Explicitly provide an owner candidate. Renma must not infer an owner when this option is absent.";
|
|
272
|
+
}, "help"];
|
|
273
|
+
}, {
|
|
274
|
+
readonly name: "suggest-semantic-split";
|
|
275
|
+
readonly usage: "renma suggest-semantic-split <file> [options]";
|
|
276
|
+
readonly question: "How can a coding agent prepare a reviewable semantic split?";
|
|
277
|
+
readonly purpose: "Suggest semantic split packages bounded source material and instructions for drafting a semantic split.";
|
|
278
|
+
readonly useWhen: readonly ["A Markdown asset is too large or mixes multiple responsibilities.", "A coding agent needs bounded source context and deterministic helper commands.", "You want a prompt or JSON review bundle before proposing a split."];
|
|
279
|
+
readonly doNotUseFor: readonly ["Editing files automatically.", "Splitting merely to satisfy a size metric when boundaries are not semantically meaningful.", "Dropping meaning, references, metadata, or review context."];
|
|
280
|
+
readonly examples: readonly ["renma suggest-semantic-split docs/large-runbook.md", "renma suggest-semantic-split docs/large-runbook.md --format json", "renma suggest-semantic-split docs/large-runbook.md --max-source-bytes 32768"];
|
|
281
|
+
readonly interpretation: readonly ["The command prints to stdout and does not edit files.", "A split must preserve meaning and references.", "The resulting patch requires review."];
|
|
282
|
+
readonly nextSteps: readonly ["Draft bounded files only when the proposed boundaries are meaningful.", "Preserve references and summarize uncertainty.", "Run scan, catalog, graph, and readiness after editing."];
|
|
283
|
+
readonly options: readonly [{
|
|
284
|
+
readonly name: "format";
|
|
285
|
+
readonly description: "Output format: prompt or json. Defaults to prompt. The command prints to stdout and does not edit files.";
|
|
286
|
+
}, "json", "max-source-bytes", "max-context-bytes", "help"];
|
|
287
|
+
}];
|
|
288
|
+
export type CommandName = (typeof COMMAND_HELP)[number]["name"];
|
|
289
|
+
export declare function isCommandName(value: string): value is CommandName;
|
|
290
|
+
export declare function renderGlobalHelp(version: string): string;
|
|
291
|
+
export declare function renderCommandHelp(name: CommandName, version: string): string;
|
|
292
|
+
export {};
|
|
293
|
+
//# sourceMappingURL=cli-help.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli-help.d.ts","sourceRoot":"","sources":["../src/cli-help.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAC;CACvC;AAED,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8EP,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,WAAW,CAAC;AAErD,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgjBkB,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAMhE,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,WAAW,CAEjE;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CA6CxD;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAyC5E"}
|