feat: agent contract — --json, path positional, exit codes, capture skill#1
Merged
Conversation
…pture skill
Makes shotkit first-class for shell-having coding agents WITHOUT an MCP server (per the surface-by-nature decision: shotkit is a heavy, file-producing build tool, so MCP is dropped from the roadmap → Non-goals).
- bin/shotkit.js: --json mode (stdout = exactly one {ok, outDir, produced[]} object; progress logs → stderr; build stdout → stderr), optional path positional (run against any checkout without cd), exit codes 0/1/2 (2 = usage/no config)
- src/cli.js: arg parsing + config resolution extracted from bin and unit-tested (25 tests total)
- src/capture.js: returns {produced, outDir}; build stdio routed by json mode
- skills/capture/SKILL.md: Claude Code skill wrapping the CLI (Agent Skills format; shipped in the npm tarball via files)
- AGENTS.md: 'Run this tool (for agents)' block (read by Claude Code/Codex/Cursor/Gemini CLI/...)
- README/README.ko: agent-contract docs; MCP row dropped with rationale; install honesty note (npm publish pending → github:#v1.1.0)
- package.json: v1.1.0; remove broken version:* script references; files += skills
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
1 participant
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.
Agent-first surfaces for shotkit, without MCP (dropped by design — heavy file-producing build tool; see Non-goals):
shotkit [path] --json→ stdout is exactly one{ok, outDir, produced[]}object (progress + build output → stderr); exit codes0/1/2.skills/capture/SKILL.md(Agent Skills format, ships in the npm tarball) + anAGENTS.mdrun-block for every shell-having agent.src/cli.jsand unit-tested (25 tests, lint clean).shotkit <starter-path> --scene 01-popup --no-video --jsonfrom an unrelated cwd — stdout parsed as JSON, RC=0; no-config path returns RC=2 with a JSON error.