From 98905ac6d36b1779220f4a682874a5afe72467c1 Mon Sep 17 00:00:00 2001 From: Leo Guinan Date: Fri, 26 Jun 2026 07:44:55 -0400 Subject: [PATCH] docs: add profile-builder recording recipe --- CHANGELOG.md | 4 + README.md | 2 + distribution.yaml | 2 +- docs/demos/README.md | 4 + .../profile-builder-terminal-recording.md | 130 ++++++++++++++++++ 5 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 docs/demos/profile-builder-terminal-recording.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 96a2ed8..b2e8a61 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All notable changes to this Hermes profile distribution are documented here. +## 0.6.6 + +- Added a focused terminal recording recipe for the interactive `profile-architect` demo, including disposable Hermes home setup, asciinema and screen-recorder paths, narration, redaction checks, and cleanup. + ## 0.6.5 - Integrated community contributor toolkit: release readiness, scorecard, discovery, wizard, demo, catalog, examples, and reusable validation action. diff --git a/README.md b/README.md index 7e19941..b32f3a0 100644 --- a/README.md +++ b/README.md @@ -158,6 +158,8 @@ Included tools: - `.github/actions/validate-profile/action.yml`: reusable validation action for generated profile repos. - `examples/gallery.json`: lightweight generated-profile gallery metadata. +For recording the interactive profile-builder workflow without exposing local credentials or private Hermes state, see [`docs/demos/profile-builder-terminal-recording.md`](docs/demos/profile-builder-terminal-recording.md). + ### Guided profile wizard ```bash diff --git a/distribution.yaml b/distribution.yaml index 292496f..ddafa09 100644 --- a/distribution.yaml +++ b/distribution.yaml @@ -1,5 +1,5 @@ name: hermes-profile-template -version: 0.6.5 +version: 0.6.6 description: "Prompt-to-repo authoring system with one-sentence generation, demo assets, diagrams, and installable Hermes Agent profile distributions." hermes_requires: ">=0.12.0" author: "CodeGraphTheory" diff --git a/docs/demos/README.md b/docs/demos/README.md index 2a637fa..1d3c7a8 100644 --- a/docs/demos/README.md +++ b/docs/demos/README.md @@ -2,6 +2,10 @@ Use this kit to record scaffold, validation, and install walkthroughs without exposing local secrets or private Hermes state. +## Recipes + +- [Profile-builder terminal recording](profile-builder-terminal-recording.md): record installing this repo as `profile-architect`, asking it to generate a concrete profile, and showing validation output from a disposable Hermes home. + ## Smoke checks ```bash diff --git a/docs/demos/profile-builder-terminal-recording.md b/docs/demos/profile-builder-terminal-recording.md new file mode 100644 index 0000000..83aa77f --- /dev/null +++ b/docs/demos/profile-builder-terminal-recording.md @@ -0,0 +1,130 @@ +# Profile-builder terminal recording recipe + +Record the interactive profile-builder demo from a disposable workspace. The goal is to show the prompt-to-profile loop without exposing local Hermes state, API keys, auth files, shell history, or personal project paths. + +## What the recording should show + +1. Install this repository as the `profile-architect` Hermes profile. +2. Start `profile-architect chat`. +3. Paste a concrete profile request, such as a database migration reviewer. +4. Show generated-profile validation output or the generated tree. +5. Stop before showing any private `.env`, auth, memory, session, or log file. + +## Disposable workspace + +Use a throwaway root so the terminal never displays your real Hermes home or personal project directories. + +```bash +export DEMO_ROOT="/tmp/hermes-profile-builder-recording" +export HERMES_HOME="$DEMO_ROOT/hermes-home" +export PROFILE_OUT="$DEMO_ROOT/database-migration-reviewer" + +rm -rf "$DEMO_ROOT" +mkdir -p "$DEMO_ROOT" +cd "$DEMO_ROOT" +``` + +Optional: shorten the shell prompt before recording so absolute local paths are not visible. + +```bash +export PS1='demo$ ' +clear +``` + +## Record with asciinema + +Install `asciinema` if needed, then record only the disposable workspace session. + +```bash +asciinema rec "$DEMO_ROOT/profile-builder-demo.cast" +``` + +Inside the recorded shell, run: + +```bash +hermes profile install github.com/codegraphtheory/hermes-profile-template \ + --name profile-architect \ + --alias \ + --yes + +profile-architect chat +``` + +Paste this prompt into the chat: + +```text +Turn "a database migration reviewer" into a fantastic installable Hermes profile repo under /tmp/hermes-profile-builder-recording/database-migration-reviewer. Expand the idea into a mature agent prompt first, preserve it in docs/profile-prompt.md, then generate the repo and run validation. Do not use real credentials. +``` + +When the agent finishes, show a short verification path: + +```bash +cd "$PROFILE_OUT" +python3 scripts/validate_profile.py . +find . -maxdepth 2 -type f | sort | sed 's#^./##' | head -40 +``` + +Stop the asciinema recording with `Ctrl-D` or by typing `exit`. + +## Record with a normal screen recorder + +If you are using QuickTime, OBS, Loom, or another screen recorder: + +1. Open a fresh terminal window. +2. Increase font size before recording. +3. Run the disposable workspace commands above. +4. Keep the terminal window cropped to the demo shell only. +5. Do not switch to browser tabs, editor windows, password managers, or other terminal panes. +6. Stop the recording before inspecting generated `.env.EXAMPLE` if your terminal scrollback includes private commands. + +## Short narration script + +Use this as the voiceover or on-screen talking points. + +```text +This demo starts in a disposable Hermes home under /tmp, so no personal profiles or credentials are used. + +First we install hermes-profile-template as profile-architect. That gives us a profile builder, not just a static template. + +Then we ask it for a concrete profile: a database migration reviewer. The builder expands the short idea into a fuller profile prompt, writes an installable repository, and runs validation. + +The important receipt is at the end: the generated repo has its own manifest, docs, skills, validation script, and a passing validation command. If validation passes, the output is ready to publish or install as a Hermes profile. +``` + +## Redaction checklist + +Before publishing the recording, verify that it does not show: + +- real API keys or tokens +- `.env` files +- `auth.json` +- private `HERMES_HOME` paths outside `/tmp/hermes-profile-builder-recording` +- `memories/`, `sessions/`, `logs/`, or other runtime state +- private repositories or customer names +- wallet addresses, unless the recording is explicitly about bounty payment +- shell history unrelated to the demo + +Safe things to show: + +- the install command +- the prompt text +- validation output +- generated file names +- `.env.EXAMPLE` placeholders, if needed + +## Cleanup + +Remove the demo profile and temporary Hermes home after recording. + +```bash +rm -rf /tmp/hermes-profile-builder-recording +``` + +If you installed the demo profile into a non-temporary Hermes home by mistake, inspect your profiles and remove the demo entry manually before publishing any follow-up recording. + +```bash +hermes profile list +hermes profile remove profile-architect +``` + +Only run the removal commands against the Hermes home you intended to use. The entire point is not turning a demo into a small archaeological incident.