@zrui-c/agent-kit

agent-kit

Portable Codex / Claude agent configuration kit.

This package contains only generic agent behavior, skills, and project scaffolding templates. It must not contain project-specific research docs, experiment results, secrets, absolute local paths, or private repository content.

What it installs

• Global Codex prompt block in $CODEX_HOME/AGENTS.md (~/.codex/AGENTS.md by default)
• pin and lesson skills in $CODEX_HOME/skills/
• Optional Claude block in ~/.claude/CLAUDE.md
• Project templates for:
  • docs/PIN_LESSON_GUIDE.md
  • docs/lessons.md
  • docs/lessons/
  • shared/pins/

Local test

node bin/agent-kit.mjs install --dry-run --no-claude
node bin/agent-kit.mjs install
node bin/agent-kit.mjs doctor

Use a temporary home for testing:

rm -rf /tmp/agent-kit-home
node bin/agent-kit.mjs install --home /tmp/agent-kit-home --no-claude --also-agents
node bin/agent-kit.mjs doctor --home /tmp/agent-kit-home

Project scaffold

node bin/agent-kit.mjs project init .
node bin/agent-kit.mjs project check .

project init only creates missing files unless --force is supplied. --with-agent-block adds a managed kit block to the project AGENTS.md.

Publish

Replace the placeholder package name in package.json first.

npm publish --access public

Then on another device:

npx @your-scope/agent-kit@latest install
npx @your-scope/agent-kit@latest project init .

To broadcast updates:

npm version patch
git push --follow-tags

Other devices:

npx @your-scope/agent-kit@latest update

Commands

agent-kit install [--dry-run] [--copy] [--home DIR] [--codex-home DIR] [--also-agents]
agent-kit update  [--dry-run] [--copy] [--home DIR] [--codex-home DIR] [--also-agents]
agent-kit doctor  [--home DIR] [--codex-home DIR]
agent-kit project init [DIR] [--dry-run] [--force] [--with-agent-block]
agent-kit project sync [DIR]
agent-kit project check [DIR]
agent-kit version

Privacy rule

Before publishing:

npm pack --dry-run

Make sure the tarball contains only bin/, src/, assets/, README.md, and LICENSE. Do not commit or publish actual project data.