Skip to content

Commit aed72d8

Browse files
committed
docs: simplify README quick start demo
1 parent 1745f5f commit aed72d8

4 files changed

Lines changed: 15 additions & 41 deletions

File tree

README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,13 @@ brew install tbcrawford/tap/opm
1515

1616
## Quick Start
1717

18-
<p align="center">
19-
<img src="assets/demo/readme-quick-start.gif" alt="Terminal demo showing opm init, create work, use work, and list" width="720" />
20-
</p>
21-
22-
```sh
23-
# migrate your current OpenCode config once
24-
❯ opm init
25-
✓ Initialized opm
26-
Migrated ~/.config/opencode → profiles/default
27-
28-
# create a second environment for a different context
29-
❯ opm create work
30-
✓ Created profile work
31-
profiles/work/
32-
33-
# switch instantly, then reload OpenCode
34-
❯ opm use work
35-
✓ default → work
36-
~/.config/opencode → profiles/work
37-
38-
❯ opm list
39-
○ default
40-
● work
41-
```
42-
4318
Each profile is a full OpenCode config directory. Switching changes what `~/.config/opencode` points to, so OpenCode keeps using the same path it already knows.
4419

4520
That is the whole flow: one command to switch, same path, no config surgery.
4621

47-
<br>
22+
<p align="center">
23+
<img src="assets/demo/readme-quick-start.gif" alt="Terminal demo showing opm init, create work, use work, and list" width="720" />
24+
</p>
4825

4926
---
5027

@@ -79,8 +56,6 @@ Nothing leaks between profiles unless you explicitly copy it.
7956
- **Transparent**: OpenCode still reads and writes `~/.config/opencode` like it always has.
8057
- **Low overhead**: no wrapper workflow, no special edit path, no new mental model after setup.
8158

82-
<br>
83-
8459
---
8560

8661
## Install
@@ -103,8 +78,6 @@ go install github.com/tbcrawford/opm@latest
10378

10479
Download the latest release from [GitHub Releases](https://github.com/tbcrawford/opm/releases), extract it, and place `opm` in your `$PATH`.
10580

106-
<br>
107-
10881
---
10982

11083
## Command Reference
@@ -134,8 +107,6 @@ opm completion zsh > "${fpath[1]}/_opm" # zsh
134107
opm completion fish > ~/.config/fish/completions/opm.fish # fish
135108
```
136109

137-
<br>
138-
139110
---
140111

141112
## How it works

assets/demo/readme-quick-start.gif

-29.3 KB
Loading

demo/readme-quick-start.tape

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,34 +27,36 @@ Type "just assemble"
2727
Enter
2828
Type "export DEMO_HOME=$(mktemp -d)"
2929
Enter
30+
Type "export HOME=$DEMO_HOME"
31+
Enter
3032
Type "export PATH=$PWD:$PATH"
3133
Enter
32-
Type "mkdir -p $DEMO_HOME/.config/opencode"
34+
Type "mkdir -p $HOME/.config/opencode"
3335
Enter
34-
Type "echo Demo profile > $DEMO_HOME/.config/opencode/AGENTS.md"
36+
Type "echo Demo profile > $HOME/.config/opencode/AGENTS.md"
3537
Enter
3638
Type "clear"
3739
Enter
3840
Show
3941

40-
Type "HOME=$DEMO_HOME opm init"
42+
Type "opm init"
4143
Enter
4244
Sleep 1.2s
4345

44-
Type "HOME=$DEMO_HOME opm create work"
46+
Type "opm create work"
4547
Enter
4648
Sleep 1.0s
4749

48-
Type "HOME=$DEMO_HOME opm use work"
50+
Type "opm use work"
4951
Enter
5052
Sleep 1.0s
5153

52-
Type "HOME=$DEMO_HOME opm list"
54+
Type "opm list"
5355
Enter
5456
Sleep 1.5s
5557

5658
Hide
5759
Type "rm -f opm"
5860
Enter
59-
Type "rm -rf $DEMO_HOME"
61+
Type "rm -rf $HOME"
6062
Enter

docs/superpowers/specs/2026-04-20-readme-vhs-demo-design.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ The output should stay close to the real CLI, but the README may still keep a li
5959
The tape should:
6060

6161
- create and use an isolated temporary `HOME`
62+
- export the temporary `HOME` during hidden setup so the visible demo can show plain `opm` commands
6263
- seed `~/.config/opencode` with a minimal real directory so `opm init` migrates something meaningful
6364
- run the built `opm` binary or the repo's standard developer entrypoint in a way that works from the repo checkout
6465
- cleanly show the commands and success output for `init`, `create`, `use`, and `list`
@@ -71,13 +72,13 @@ The tape should not:
7172

7273
## README Integration
7374

74-
The README should embed the GIF directly below `## Quick Start` and above the shell snippet.
75+
The README should embed the GIF directly below `## Quick Start` and replace the now-redundant shell snippet.
7576

7677
The embed should:
7778

7879
- render at a medium width appropriate for the quick-start section
7980
- use alt text that makes sense for readers and accessibility tools
80-
- keep the existing quick-start code block beneath it
81+
- keep the short explanatory copy beneath it
8182

8283
The README should not add a large maintenance section. The demo should feel like a natural part of the quick-start section, not a separate documentation feature.
8384

0 commit comments

Comments
 (0)