Skip to content

docs: add clrun install + interactive prompt handling guidance#919

Open
cybertheory wants to merge 2 commits intogarrytan:mainfrom
cybertheory:docs/add-clrun-tui-guidance
Open

docs: add clrun install + interactive prompt handling guidance#919
cybertheory wants to merge 2 commits intogarrytan:mainfrom
cybertheory:docs/add-clrun-tui-guidance

Conversation

@cybertheory
Copy link
Copy Markdown

Summary

This PR adds explicit clrun guidance for handling interactive CLI/TUI prompts in gstack skills, and does so in the template/source path required by the contributing guidelines.

What changed

  • Updated shared preamble source:
    • scripts/resolvers/preamble.ts
  • Added a dedicated Interactive CLI / TUI handling section that documents:
    • when to use clrun (interactive prompts, wizards, yes/no, select/checkbox UIs)
    • core execution flow (clrun <command>clrun tail → respond)
    • text input and key navigation patterns (clrun <id> "...", clrun key ...)
    • session management (clrun status, clrun kill)
    • shell-variable quoting guidance
  • Added install/fallback guidance:
    • install if missing: npm install -g clrun
    • no-global fallback: npx clrun <command>
  • Regenerated generated docs from templates across hosts (SKILL.md and per-skill generated outputs).

Why

The existing docs described policy for interactive prompts but did not provide a deterministic operational workflow for terminal interactivity. This change makes agent behavior explicit and repeatable, including setup when clrun is not installed.

Validation

  • Regenerated docs:
    • bun run gen:skill-docs --host all
  • Verified consistency and freshness:
    • bun run skill:check
  • Checks pass with expected warnings for skills that intentionally have no $B commands.

Add clrun interactive CLI/TUI guidance in the shared preamble source and regenerate SKILL.md outputs from templates so documentation stays generated and consistent.
Document how to install clrun when missing and include npx fallback, then regenerate generated skill docs to keep template outputs in sync.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant