Skip to content

Commit 3fbd705

Browse files
ProfRandom92ProfRandom92
committed
Add VHS demo plan for CompText CLI
1 parent 4cdda46 commit 3fbd705

5 files changed

Lines changed: 157 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ cargo run --bin ctxt -- --json startup flow
7878
cargo run --bin ctxt -- --json review workflow
7979
```
8080

81+
For a small terminal demo plan, see [docs/DEMO.md](docs/DEMO.md).
82+
8183
### Planned Release Workflow
8284

8385
The crate install path is planned for the tagged release. Until the crate is published, use the source workflow above.

‎assets/demo/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎assets/demo/ctxt-demo.tape‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Output assets/demo/ctxt-demo.gif
2+
3+
Set Shell "powershell"
4+
Set Width 960
5+
Set Height 540
6+
Set FontSize 16
7+
Set FontFamily "Cascadia Mono"
8+
Set Theme "Dracula"
9+
Set Padding 18
10+
Set TypingSpeed 25ms
11+
12+
Sleep 500ms
13+
Type "cargo run --bin ctxt -- --json startup readiness"
14+
Enter
15+
Sleep 1s
16+
17+
Type "cargo run --bin ctxt -- --json capabilities"
18+
Enter
19+
Sleep 1s
20+
21+
Type "cargo run --bin ctxt -- --json review workflow"
22+
Enter
23+
Sleep 1s
24+
25+
Type "cargo run --bin ctxt -- --json validate --run"
26+
Enter
27+
Sleep 2s

‎docs/DEMO.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# CompText CLI Terminal Demo
2+
3+
This page documents the small VHS terminal demo asset for CompText CLI. The demo is intended for README and release-candidate review use: it shows the local JSON-oriented command surface without changing runtime code.
4+
5+
## Purpose
6+
7+
The demo gives reviewers a short visual pass through the commands that describe startup readiness, capabilities, review workflow, and local validation.
8+
9+
The script is stored as a VHS tape at `assets/demo/ctxt-demo.tape`. VHS keeps the terminal demo encoded as text so the commands, timing, dimensions, and output target are reviewable before a GIF is rendered.
10+
11+
## Demo Commands
12+
13+
```powershell
14+
cargo run --bin ctxt -- --json startup readiness
15+
cargo run --bin ctxt -- --json capabilities
16+
cargo run --bin ctxt -- --json review workflow
17+
cargo run --bin ctxt -- --json validate --run
18+
```
19+
20+
These commands are local CLI invocations. They do not call providers, enable network access, execute external agents, execute subagents, apply proposals, or change runtime behavior.
21+
22+
## Preview And Render
23+
24+
VHS must be installed locally before rendering.
25+
26+
```powershell
27+
vhs --version
28+
vhs assets/demo/ctxt-demo.tape
29+
```
30+
31+
The tape is configured to write `assets/demo/ctxt-demo.gif`. Rendering is optional for the repository: if the GIF is larger than 5 MB or rendering fails, keep only the text tape and documentation.
32+
33+
The intended visual style is a dark terminal window suitable for a compact README demo. Runtime duration can vary because the tape runs `cargo run` commands against the local checkout.
34+
35+
Current local render note: `vhs --version` reported `vhs version v0.11.0 (c6af91a)`, but `vhs assets/demo/ctxt-demo.tape` failed because `ttyd` is not installed. No GIF was committed for this attempt.
36+
37+
## Boundaries
38+
39+
- No secrets are required or expected.
40+
- No network is required by the demo commands.
41+
- No provider calls are part of the demo.
42+
- No runtime-code changes are part of the demo asset plan.
43+
- Generated media should be treated as optional review material, not source of truth.

‎tasks/VHS_DEMO.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# VHS Demo Asset Plan
2+
3+
## Phase
4+
5+
VHS Demo Asset Plan
6+
7+
## Mode
8+
9+
visual-assets
10+
11+
## Read-First Files
12+
13+
- `AGENTS.md`
14+
- `PROJEKT.md`
15+
- `tasks/VHS_DEMO.md`
16+
- `.agents/skills/ctxt-runtime/SKILL.md`
17+
- `.agents/skills/ctxt-antigravity-runtime/SKILL.md`
18+
- `C:\Users\contr\.agents\skills\cli-developer\SKILL.md`
19+
20+
## Goal
21+
22+
Prepare a small VHS-based terminal demo plan for CompText CLI without changing runtime code, tests, release metadata, workflows, provider configuration, or secrets.
23+
24+
## Allowed Files
25+
26+
- `tasks/VHS_DEMO.md`
27+
- `docs/DEMO.md`
28+
- `assets/demo/.gitkeep`
29+
- `assets/demo/ctxt-demo.tape`
30+
- `README.md` only for a short link to `docs/DEMO.md`
31+
32+
## Forbidden Files
33+
34+
- `src/**`
35+
- `tests/**`
36+
- `Cargo.toml`
37+
- `Cargo.lock`
38+
- `.github/**`
39+
- `assets/brand/**`
40+
- `AGENTS.md`
41+
- `PROJEKT.md`
42+
- `.agents/**`
43+
- `reports/**`
44+
- `RELEASE_NOTES_v0.1.0.md`
45+
- provider configs
46+
- secrets or credential-bearing files
47+
- release tags, release objects, crate publication, or generated large media assets
48+
49+
## Implementation Rules
50+
51+
- Use VHS only as a local terminal-demo renderer.
52+
- Keep the tape README-friendly and short.
53+
- Do not add runtime behavior.
54+
- Do not invoke providers.
55+
- Do not enable network access from the demo commands.
56+
- Do not read or print secrets.
57+
- Treat rendered GIF output as optional and exclude it from commit if rendering fails or the file is larger than 5 MB.
58+
59+
## Validation
60+
61+
```powershell
62+
git --no-pager diff --stat
63+
git --no-pager diff -- tasks/VHS_DEMO.md docs/DEMO.md assets/demo/ctxt-demo.tape README.md
64+
git --no-pager status --short --branch
65+
Select-String -Path README.md,docs/DEMO.md,tasks/VHS_DEMO.md -Pattern `
66+
<forbidden release and runtime assurance claims from the phase prompt>
67+
```
68+
69+
## Return Schema
70+
71+
```text
72+
PHASE: VHS Demo Asset Plan
73+
STATUS: <success | blocked>
74+
FILES_CHANGED: <list of changed files>
75+
COMMANDS_RUN: <list of commands executed>
76+
VALIDATION: <validation output summary>
77+
ARTIFACTS: <list of generated artifacts>
78+
GIT: <commit SHA(s) and push status if explicitly authorized>
79+
NETWORK: <offline-only | allowed-external for git fetch/push only>
80+
SECRETS: <secrets status>
81+
POLICY_DECISIONS: <policy status>
82+
RISKS: <remaining risks or release blockers>
83+
NEXT: <next action>
84+
```

0 commit comments

Comments
 (0)