@teakit/cli

@teakit/cli LLM Contract

@teakit/cli is the command-line tool for creating, adopting, checking, and maintaining Teakit kits.

Current Status

The package has been renamed from the old boilerplate template to @teakit/cli.

The final CLI command implementation is still pending. Do not generate code that assumes the planned commands are already implemented unless the relevant source and tests exist.

Planned Command Surface

NeedPlanned command
Create a new Teakit kitteakit kit new <name>
Adopt Teakit standards in an existing packageteakit kit adopt <path>
Check Teakit complianceteakit kit doctor <path>
Sync shared Teakit skillteakit skill sync <path>

Generation Rules

  • Treat @teakit/cli as a CLI package, not a reusable library template.
  • Do not refer to this package as @teakit/boilerplate.
  • Do not use project-template as the package skill name.
  • Do not treat the old add example as public product API.
  • Clearly distinguish planned commands from implemented commands.
  • When CLI behavior, commands, flags, package exports, or agent-facing usage changes, update README.md, skills/index.mdx, skills/teakit-cli/SKILL.md, and this file.

Project Workflow

  • Read AGENTS.md before modifying the repository.
  • Read docs/knowledge/index.md and docs/memory/index.md when context is needed.
  • Read skills/teakit-cli/SKILL.md before changing command-facing behavior or command documentation.
  • If API, behavior, commands, or agent-facing usage changes, update nearby tests and docs.