lit (prompt / instruct generator)

Generate timestamped instruction files in ./instructs/ from a template, with optional per-project local templates.

Install / Run

• Build: pnpm build
• Run locally: pnpm dev (runs src/index.ts)
• Tests: pnpm test

If you install this package as a CLI, it exposes the lit command.

Commands

lit (default)

Creates a new file under ./instructs/:

• Output path: instructs/YYYY-MM-DD-HH-MM-SS-<template>-<name>.md
• If --template or --name are missing, lit will prompt interactively.

Options:

• -t, --template <template>: feat | refactor | fix
• -n, --name <name>: instruction filename suffix (sanitized)
• --official: never prompt about local templates; always use bundled templates/*.md
• --local-templates [folder]: force using local templates (and create/copy them if needed)
  • When omitted, defaults to ./.ins-template
  • folder can be a relative path (to cwd) or an absolute path

lit init [folder]

Explicitly creates/uses a local template folder and copies bundled templates into it.

• Default folder: .ins-template
• Only copies missing files; it does not overwrite existing local template files.

Options:

• -y, --yes: skip the confirmation prompt

Examples:

• lit init (prompts, creates ./.ins-template)
• lit init my-templates -y (no prompt, creates ./my-templates)

Template selection logic (default lit command)

Let:

• official templates = bundled templates/*.md shipped with the CLI
• local templates = a folder in your working directory (default ./.ins-template)

Resolution order:

1. If --official is set: use official templates (no prompt).
2. Else if --local-templates is set: use local templates (ensure folder exists + copy missing templates).
3. Else if the local templates folder already exists: use local templates (ensure missing templates are copied).
4. Else if ./instructs/ already exists: use official templates (no prompt).
5. Otherwise (fresh folder): ask whether to create/use local templates.
   • Yes: create local folder + copy templates, then use local templates
   • No: use official templates

Customizing templates

1. Run lit init (or lit init <folder>) in your project.
2. Edit the copied *.md files inside your local template folder.
3. Run lit --local-templates (or rely on auto-detection once the local folder exists).