genfile 0.6.0

CLI for genfile_core template archive management - create, manage, and materialize code generation templates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# Feature: Help System

### Scope

- **Purpose**: Provides universal and per-command help access via auto-generated help commands.
- **Responsibility**: Documents the help system behavior and filtering rules.
- **In Scope**: `.` and `.help` universal help; `.command.help` per-command help; help filtering from listings.
- **Out of Scope**: Command implementation details, verbosity levels on non-help commands.

### Design

Universal help (`.` or `.help`) lists all registered non-help commands with their hints and examples. Per-command help (e.g., `.archive.new.help`) shows the command description, all parameters with kinds and defaults, and usage examples. Help commands are auto-generated for every registered command and filtered from command listings to avoid noise.

### Invariants

| File | Relationship |
|------|--------------|
| [`invariant/002_usability.md`](../invariant/002_usability.md) | Usability constraint that help system format must satisfy |
| [`invariant/006_documentation.md`](../invariant/006_documentation.md) | Documentation completeness constraint enforced through help |

### Docs

| File | Relationship |
|------|--------------|
| [`docs/cli/readme.md`](../cli/readme.md) | CLI documentation including help system overview |

### Sources

| File | Relationship |
|------|--------------|
| [`src/commands/mod.rs`](../../src/commands/mod.rs) | Registry that enables auto-generated help |