@teakit/cli

@teakit/cli

Use this skill when working on @teakit/cli.

@teakit/cli is intended to be the executable companion to the shared Teakit tslib standards.

Current Status

The repository has been converted from the old boilerplate template into @teakit/cli.

The final CLI command implementation is still pending. Documentation may describe planned commands, but code generation must not assume a command exists until it is implemented and tested.

Core Rules

  1. Treat this repository as a CLI package, not a TypeScript library template.
  2. Do not refer to this package as @teakit/boilerplate.
  3. Do not use project-template as the package-specific skill name.
  4. Do not treat the old boilerplate example as product API.
  5. Clearly distinguish planned command surface from implemented command behavior.
  6. Keep command docs, README, LLM contract, tests, and source code synchronized.
  7. Use Bun as the development environment, test runner, script runner, and runtime target.
  8. Keep runtime dependencies empty unless a future proposal changes this rule.
  9. Do not invent command flags, aliases, package exports, or binary names that are not implemented or accepted.
  10. Do not reintroduce the previous command surface unless a future proposal explicitly changes it.
  11. Do not add a fix mode to teakit doctor; it should output results for an AI agent to apply.

Planned Commands

CommandPurpose
teakit create <name>Create a new Teakit tslib project from the default tslib template.
teakit doctorCheck the current working directory and output agent-readable structured findings.

Workflow

  1. Identify whether the task changes package metadata, command behavior, source code, tests, docs, or agent-facing usage.
  2. Read README.md, skills/llms.md, docs/proposals/v1-implementation.md, and relevant source/test files.
  3. If command behavior is planned but not implemented, keep language explicit about pending implementation.
  4. Make scoped changes that move the package away from the old boilerplate identity and toward @teakit/cli.
  5. Update nearby tests and docs when behavior changes.
  6. Run relevant verification when possible: bun run check, bun run typecheck, bun run test, bun run build, and bun run docs:build.
  7. Report any verification that could not run.

Reference Selection

Detailed command references are not yet defined. Add focused files under skills/teakit-cli/references/ when command behavior is implemented.