@teakit/cli LLM Contract

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

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 tslib projectteakit create <name>
Check the current project for Teakit tslib complianceteakit doctor

Bun Runtime Contract

  • Use Bun as the development environment, test runner, script runner, and CLI runtime target.
  • Implement CLI behavior with Bun-provided APIs and built-in platform capabilities.
  • Keep runtime dependencies empty.
  • Generated tslib projects should default to Bun.

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 boilerplate example as public product API.
  • Clearly distinguish planned commands from implemented commands.
  • Do not reintroduce the previous command surface unless a future proposal explicitly changes it.
  • Do not add a fix mode to teakit doctor; it should output results for an AI agent to apply.
  • 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 docs/proposals/v1-implementation.md for the current V1 command direction while implementation is pending.
  • 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.