Skip to content

Commit f3fb429

Browse files
committed
docs(agent): clarify status command behavior for universal and symlinked agents
- Update DOCUMENTATION.md to explain that 'agent status' checks each installed skill against CLI version - Clarify that universal agents share one canonical skill file serving all agents - Explain symlinked agents appear only when their own landing exists - Update CLI help text to reflect these details for 'agent status' command - Adjust snapshot test output to match the revised command description and behavior
1 parent 7376a85 commit f3fb429

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ There are two kinds of agent:
126126

127127
`.agents/skills/` is the **single source of truth**: it is written on every install, even when you target a symlinked agent — `agent install --target claude-code` lands the skill in `.agents/skills/` (covering every universal agent) **and** links it into `.claude/skills/`. Because each symlink points _into_ `.agents/skills/`, you only ever edit a skill there and every symlinked agent reflects the change automatically (on systems where symlinks are unavailable — e.g. Windows without Developer Mode — a plain copy is written instead, which won't auto-update).
128128

129-
`agent status` checks the canonical skill file (and each symlinked landing) against the current CLI version and reports `ok`, `stale`, `modified`, or `unmarked` for every agent that has an install (absent agents are omitted to keep output focused). It exits `1` when anything needs attention, so `testsprite agent status && …` can gate a CI step; `--dir <path>` inspects a different project root.
129+
`agent status` checks each installed skill against this CLI version and reports `ok`, `stale`, `modified`, or `unmarked`. Symlinked agents appear only when their own landing exists; universal agents share one canonical skill file (`.agents/skills/`), so installing for any one of them serves every universal agent and they all report together. Agents with nothing installed are omitted. It exits `1` when anything needs attention, so `testsprite agent status && …` can gate a CI step; `--dir <path>` inspects a different project root.
130130

131131
Re-running with `--force` overwrites a canonical file that has drifted, backing up the existing bytes to `<path>.bak` first; for symlinked landings it replaces a link that points elsewhere.
132132

src/commands/agent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1101,7 +1101,7 @@ export function createAgentCommand(deps: AgentDeps = {}): Command {
11011101
agent
11021102
.command('status')
11031103
.description(
1104-
'Check installed TestSprite skills against this CLI version (ok/stale/modified/unmarked). Reports only agents that have an install; exits 1 when any need attention, so it can gate CI',
1104+
'Check installed TestSprite skills against this CLI version (ok/stale/modified/unmarked). Universal agents share one canonical skill file (installing for any one serves all); symlinked agents appear only when their own landing exists. Exits 1 when any need attention, so it can gate CI',
11051105
)
11061106
.option('--dir <path>', 'Project root to inspect (default: cwd)')
11071107
.addHelpText('after', GLOBAL_OPTS_HINT)

test/__snapshots__/help.snapshot.test.ts.snap

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ Commands:
1616
whether they read .agents/skills directly (universal) or
1717
via symlink
1818
status [options] Check installed TestSprite skills against this CLI version
19-
(ok/stale/modified/unmarked). Reports only agents that
20-
have an install; exits 1 when any need attention, so it
21-
can gate CI
19+
(ok/stale/modified/unmarked). Universal agents share one
20+
canonical skill file (installing for any one serves all);
21+
symlinked agents appear only when their own landing
22+
exists. Exits 1 when any need attention, so it can gate CI
2223
help [command] display help for command
2324
"
2425
`;

0 commit comments

Comments
 (0)