diff --git a/changelog.d/added-sync-pluk-hotshot-roadmap.md b/changelog.d/added-sync-pluk-hotshot-roadmap.md new file mode 100644 index 0000000..2541a41 --- /dev/null +++ b/changelog.d/added-sync-pluk-hotshot-roadmap.md @@ -0,0 +1 @@ +- Sync and link `pluk` and `hotshot` `ROADMAP.md` on docs.hivecommons.dev. diff --git a/docs/content/hotshot/roadmap.md b/docs/content/hotshot/roadmap.md new file mode 100644 index 0000000..6441708 --- /dev/null +++ b/docs/content/hotshot/roadmap.md @@ -0,0 +1,34 @@ +> **Synced from hotshot.** This page is pulled from [hivecommons/hotshot@main](https://github.com/hivecommons/hotshot/blob/main/ROADMAP.md) during the docs build. Edit the canonical source in the hotshot repository. + +# Hotshot Roadmap + +Hotshot is a small cross-platform bridge from screenshots to AI terminals. This +roadmap records the near-term direction so contributors can align work across +the macOS app, Linux script, and Windows helper. + +## Recently shipped + +- macOS, Linux, and Windows screenshot-to-terminal flows with CLI-aware text + injection for Claude Code, GitHub Copilot CLI, aider, and opencode. +- Clipboard enrichment with image data, file URLs, and shell-escaped text paths. +- Hermetic Linux and Windows tests plus extracted `HotshotCore` helpers for + shared macOS decision logic. + +## Near term + +1. **Package distribution:** publish first-class install paths beyond manual + scripts, starting with Homebrew and documenting follow-on candidates such as + winget and distro packages. +2. **Cross-platform parity:** keep Linux Wayland/X11 and Windows behavior aligned + with macOS for clipboard modes, typed injection, warning paths, and safe + degradation when helper tools are missing. +3. **More terminal and agent targets:** expand detection and examples for + terminals and AI CLIs as the ecosystem changes, while keeping unknown targets + on safe, explicit fallback behavior. + +## Non-goals for now + +- Full screen recording, GIF capture, or video editing workflows. +- Remote desktop or SSH session discovery beyond terminal/tmux-oriented flows. +- Cloud storage or hosted screenshot processing; Hotshot should remain local by + default. diff --git a/docs/content/pluk/roadmap.md b/docs/content/pluk/roadmap.md new file mode 100644 index 0000000..bf12c60 --- /dev/null +++ b/docs/content/pluk/roadmap.md @@ -0,0 +1,38 @@ +> **Synced from pluk.** This page is pulled from [hivecommons/pluk@main](https://github.com/hivecommons/pluk/blob/main/ROADMAP.md) during the docs build. Edit the canonical source in the pluk repository. + +# Pluk Roadmap + +Pluk turns AI-agent terminal output into structured events that downstream +tools can consume. This roadmap describes the direction for the TypeScript +package and its relationship with the wider Hive Commons agent-tooling stack. + +## Recently shipped + +- TypeScript CLI and library support for attaching tmux sessions, classifying + output, subscribing to JSONL logs, and sending text back into sessions. +- Built-in pattern sets for Claude, Copilot, Gemini, and Goose. +- Rationguard integration through `pluk attach --rationguard` and stable event + fields consumed by companion tools. + +## Near term + +1. **Event schema stability:** document compatibility expectations for the JSONL + event format so tools such as rationguard and hotshot can depend on it safely. +2. **Broader CLI coverage:** add and test pattern packs for additional active + agent CLIs as they become adoption-relevant. +3. **Operational hardening:** continue replacing tmux/terminal edge cases with + explicit diagnostics, non-zero exits for operator errors, and hermetic tests. + +## Go and TypeScript relationship + +The TypeScript package is the npm-facing implementation for JavaScript users and +companion tools. The Go implementation remains useful where a static binary is +preferred. Near-term work should keep event shapes and user-facing semantics +aligned rather than forcing a repository merge. + +## Non-goals for now + +- A hosted event service or centralized session registry. +- Shells or terminal multiplexers beyond tmux until there is clear demand. +- Agent-control policy decisions; pluk should publish and deliver events, while + consumers decide how to react. diff --git a/scripts/sync-sibling-docs.ts b/scripts/sync-sibling-docs.ts index 9c1b479..369d94d 100644 --- a/scripts/sync-sibling-docs.ts +++ b/scripts/sync-sibling-docs.ts @@ -75,6 +75,7 @@ export const PROJECTS: ProjectSync[] = [ { source: "README.md", target: "readme.md", required: true }, { source: "linux/README.md", target: "linux.md" }, { source: "windows/README.md", target: "windows.md" }, + { source: "ROADMAP.md", target: "roadmap.md" }, ], }, { @@ -82,7 +83,10 @@ export const PROJECTS: ProjectSync[] = [ owner: SIBLING_OWNER, repo: "pluk", branch: process.env.PLUK_DOCS_REF || "main", - files: [{ source: "README.md", target: "readme.md", required: true }], + files: [ + { source: "README.md", target: "readme.md", required: true }, + { source: "ROADMAP.md", target: "roadmap.md" }, + ], }, { project: "rationguard", diff --git a/src/app/docs/page-map.ts b/src/app/docs/page-map.ts index f2a0a8e..bffb232 100644 --- a/src/app/docs/page-map.ts +++ b/src/app/docs/page-map.ts @@ -166,6 +166,7 @@ const NAV_STRUCTURE_HOTSHOT: Array<{ title: string; items: NavItem[] }> = [ title: 'Overview', items: [ { 'Introduction': 'readme.md' }, + { 'Roadmap': 'roadmap.md' }, ] }, { @@ -183,6 +184,7 @@ const NAV_STRUCTURE_PLUK: Array<{ title: string; items: NavItem[] }> = [ title: 'Overview', items: [ { 'Introduction': 'readme.md' }, + { 'Roadmap': 'roadmap.md' }, ] } ]