docs(skills/acpx): bring SKILL.md up to 0.7 surface#305
Open
superWorldSavior wants to merge 2 commits intoopenclaw:mainfrom
Open
docs(skills/acpx): bring SKILL.md up to 0.7 surface#305superWorldSavior wants to merge 2 commits intoopenclaw:mainfrom
superWorldSavior wants to merge 2 commits intoopenclaw:mainfrom
Conversation
The bundled skill currently lags behind the 0.7 release. This PR brings the document up to date with the API and CLI surface that ships today. Additions: - Frontmatter description now mentions system-prompt overrides and the defineFlow/decision/decisionEdge authoring API so triggering reflects what users actually invoke acpx for in 0.7. - New global flags documented: --system-prompt, --append-system-prompt, --no-terminal, --prompt-retries, --allowed-tools, --max-turns, --non-interactive-permissions, --json-strict. - Sessions section gains `sessions ensure` (idempotent get-or-create) and `sessions prune` (--dry-run, --before, --older-than, --include-history) with behavior notes. - New "System prompt override (Claude)" section explaining the _meta.systemPrompt forwarding, persistence into session_options, and the cross-agent ignore semantics. - New "Sessions cleanup" section with retention examples. - "Flow run" mention is replaced by a full "Flows (multi-agent workflows)" section: complete defineFlow example (pr-triage), table of node types (acp/decision/action/compute/checkpoint), three edge shapes (linear, JSONPath switch, decisionEdge), and a short rationale for cross-vendor / replay / permission preflight / typed routing. - Practical workflows gains a Claude reviewer with persistent --system-prompt, an `ensure`-based script bootstrap, a prune retention example, and a flow run example. Sources cross-checked against docs/CLI.md, docs/flows.md, examples/flows/branch.flow.ts, and the 0.7.0 binary --help output. No assertions made about features that are not in 0.7. AI-assisted: drafted with Claude (Opus 4.7). Lightly tested locally: - SKILL.md renders correctly in Claude Code skill loader. - Code samples mirror examples/flows/branch.flow.ts verbatim where applicable; CLI snippets verified against acpx 0.7.0 --help. No source code changed, so build/check/test are unaffected. CI will confirm.
The CLI surface confirmed by acpx 0.7.0 --help: --older-than <days> Prune sessions closed more than N days ago Fixing the prune examples accordingly: 7d/14d/30d -> 7/14/30.
Merged
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates
skills/acpx/SKILL.mdso the bundled skill reflects the 0.7 surface instead of the pre-0.6 subset.Why
The skill is the canonical reference an agent loads when it sees
acpxmentioned. Today it is missing every flag and subcommand added in 0.6 and 0.7, so an agent asking "how do I prune old sessions?" or "how do I author a flow withdecision()?" gets nothing useful and falls back to guessing. This PR makes the doc match what the binary already does.What's added
Frontmatter
description: now mentions system-prompt overrides anddefineFlow/decision/decisionEdgeso triggering reflects 0.7 use cases.Core capabilities (bullet list): 5 new lines covering
sessions ensure,sessions prune, system-prompt overrides,--no-terminal,--allowed-tools/--max-turns/--prompt-retries, and the flows API.Command model:
sessions ensure,sessions prune [--dry-run] [--before <date> | --older-than <days>] [--include-history], andflow run <file> [--input-json | --input-file] [--default-agent].Sessions section:
ensure(idempotent get-or-create) andpruneexamples + behavior notes (retention by close time vs last-used,--include-historyevent-stream cleanup).Global options — adds:
--non-interactive-permissions <deny|fail>--json-strict--system-prompt <text>/--append-system-prompt <text>--allowed-tools <list>--max-turns <count>--prompt-retries <count>--no-terminalNew section: System prompt override (Claude) — documents the
_meta.systemPrompt/_meta.systemPrompt.appendforwarding, persistence intosession_options.system_prompt, and the cross-agent ignore semantics. Includes aclaude -s reviewerexample.New section: Sessions cleanup — retention guidance and
pruneexamples.New section: Flows (multi-agent workflows) — replaces the two-line "Flow run" mention with:
acpx flow runinvocations (file + JSON input,--default-agent)defineFlowexample (pr-triage withdecision,acp,checkpoint,decisionEdge) modeled afterexamples/flows/branch.flow.tsacp,decision,action,compute,checkpointto, JSONPathswitch, exhaustivedecisionEdgePractical workflows — 4 new examples: persistent
--system-promptClaude reviewer,sessions ensurescript bootstrap,sessions pruneretention, multi-agent flow run.Sources
Every claim and signature in this diff is derived from one of:
docs/CLI.md— sessions subcommands, flow run, global optionsdocs/flows.md— flows authoring APIexamples/flows/branch.flow.ts—decision({ choices, question })anddecisionEdge({ from, choices, cases })shapesacpx 0.7.0 --help— every flag listed in this PRCHANGELOG.md— 0.6.0 and 0.7.0 entriesI did not invent any shape or flag. Where the source is silent (e.g., the full
action/computeparameter sets), the doc stays minimal rather than guessing.Testing
Doc-only change. No source code touched, so
pnpm build && pnpm check && pnpm test:coverageshould be unaffected. I have not run them locally — relying on CI.I have not type-checked the embedded code samples in a scratch project. They are written to mirror
examples/flows/branch.flow.tsshapes; happy to validate against a realacpx/flowsimport if maintainers prefer.AI disclosure
Per
CONTRIBUTING.md:{ choices, question },{ from, choices, cases }) and CLI flag semantics (_meta.systemPromptforwarding,pruneretention behavior) are pulled from the source files in this repo, not from training data or third-party blog posts.Out of scope
action/compute/checkpointparameters are documented only at the level present indocs/flows.md.Happy to split, trim, or expand any section based on review.