Scaffold New Lumen CLI Command

VerifiedCaution

Steps to scaffold a new Lumen CLI command following the Commander.js register pattern.

Sby Skills Guide Bot
DevelopmentIntermediate
7/22/2026
Claude Code
#cli#scaffolding#commander-js#typescript#code-generation

Recommended for

Automated summary

Scaffolds a new Lumen CLI command or subcommand following the repository's Commander.js registration pattern.

Strengths

  • Gives an ordered checklist: inspect existing commands, create the file under src/commands/, then register it in src/cli.ts
  • Enforces a type check with npx tsc --noEmit and a smoke test against a temporary LUMEN_DIR
  • Restates project conventions: mandatory .description(), try/catch around async actions, audit(), loadConfig() and getDb()
  • Includes an explicit decision point on whether the command needs an LLM, requiring full offline behavior if not

Limitations

  • Tightly coupled to the Lumen repo layout and helpers, so it is not portable to other projects
  • Assumes templates/command.ts.md and the CLAUDE.md rules exist and are current
  • Covers no automated test authoring beyond manually running the command once
When to use it

Use it when adding a new command or subcommand to the Lumen CLI in line with the project's conventions.

When not to use it

Avoid it when editing an existing command without creating one, or when working outside the Lumen repository.

Security analysis

Caution
Quality score86/100

The skill guides normal repository scaffolding and local verification commands. It does not instruct destructive actions, exfiltration, obfuscated payloads, or disabling safety measures. The only notable risk is local command execution via npx/tsx, which is appropriate for a development workflow but warrants caution.

Findings
  • •Instructs executing local shell commands (`npx tsc --noEmit`, `npx tsx src/cli.ts ...`) for verification and testing; legitimate but relies on trusted local dependencies.
How this analysis is made

Examples

New export command
Create a new Lumen CLI command `export` that writes the compiled index to a JSON file, and register it in src/cli.ts.
Offline stats subcommand
Add a `stats` subcommand to the Lumen CLI that reports document counts from the database — it must work fully offline, no LLM.
Scaffold from template
Scaffold a new Lumen CLI command named `prune` using templates/command.ts.md, register it, then run tsc and a smoke test.

name: new-command description: Scaffold a new Lumen CLI command following the Commander.js register pattern. TRIGGER when user asks to create, add, or implement a new CLI command or subcommand.

Scaffold New Lumen CLI Command

Lumen is CLI-first. Every feature starts as a CLI command. Follow all rules in CLAUDE.md.

Before Scaffolding

  1. Check src/cli.ts for already-registered commands
  2. Check if a stub exists in src/commands/
  3. Decide: does this command need LLM? If no, it must work fully offline

Steps

  1. Create or edit src/commands/<name>.ts using templates/command.ts.md
  2. Register in src/cli.ts:
    import { registerX } from './commands/x.js';
    registerX(program);
    
  3. Run npx tsc --noEmit to verify
  4. Test: LUMEN_DIR=$(mktemp -d) npx tsx src/cli.ts <command> <args>

Command-Specific Rules

  • Every command needs .description() for --help
  • Async actions must wrap in try/catch — Commander does not handle rejections
  • Use audit() for operations that change state (add, compile, delete)
  • Use loadConfig() for settings, getDb() for database — both auto-initialize

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/scaffold-new-lumen-cli-command-mrwak94c/download' --output '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md.part' && mv '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md.part' '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md' && test -s '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/new-command' && cp -R '.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c' '.claude/skills/new-command'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/scaffold-new-lumen-cli-command-mrwak94c'

openskills read 'scaffold-new-lumen-cli-command-mrwak94c'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/scaffold-new-lumen-cli-command-mrwak94c/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills