agentleFS
naman10parikhnaman10parikh/pixel/.claude/skills/oss-project-scaffold/SKILL.md

oss-project-scaffold

Skill0 starsChanged 27 days agoMITView on GitHub

Scaffold a new OSS CLI project with package.json, tsconfig, README template, Vitest, CI, and LICENSE. The standardized starting point for all Energy OSS tools.

  • Installs packages

4 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When creating a new CLI tool in tools/ or oss-projects/

    line 8
  2. Distinctive:

    When META-FORGE or any company spawns a builder for a new OSS project

    line 9
  3. Distinctive:

    When starting any TypeScript CLI that will be published to npm

    line 10
  4. Very specific:

    Follow the shared conventions in .claude/contracts/shared.md:

    line 126
  5. Distinctive:

    All boilerplate handled — builder can focus on core logic

    line 150

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

When to Use

  • When creating a new CLI tool in tools/ or oss-projects/
  • When META-FORGE or any company spawns a builder for a new OSS project
  • When starting any TypeScript CLI that will be published to npm

Process

Step 1: Create Directory Structure

{project-name}/
├── src/
│   ├── index.ts          # CLI entry point (commander.js)
│   ├── types.ts           # Type definitions
│   └── utils.ts           # Shared utilities
├── tests/
│   └── index.test.ts      # Vitest tests
├── bin/
│   └── {project-name}.js  # Compiled CLI entry (shimmed by build)
├── package.json
├── tsconfig.json
├── vitest.config.ts
├── README.md
├── LICENSE
├── .npmignore
└── .gitignore

Step 2: Package.json Template

{
  "name": "{project-name}",
  "version": "1.0.0",
  "description": "{one-liner}",
  "bin": {
    "{project-name}": "./dist/index.js"
  },
  "main": "./dist/index.js",
  "types": "./dist/index.d.ts",
  "files": ["dist/", "README.md", "LICENSE"],
  "scripts": {
    "build": "tsc",
    "dev": "tsc --watch",
    "test": "vitest run",
    "test:watch": "vitest",
    "prepublishOnly": "pnpm build && pnpm test"
  },
  "license": "MIT",
  "engines": { "node": ">=18" },
  "keywords": ["ai", "claude", "agent", "{category}"],
  "author": "Naman Parikh",
  "repository": {
    "type": "git",
    "url": "https://github.com/naman10parikh/{project-name}"
  }
}

Step 3: Dependencies (Common Stack)

pnpm add commander chalk       # CLI essentials
pnpm add -D typescript vitest @types/node  # Dev tools

Optional (add only if needed):

  • ora — spinners
  • cli-table3 — table output
  • boxen — boxed output
  • inquirer — interactive prompts
  • blessed or ink — full TUI dashboard

Step 4: TSConfig Template

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "declaration": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist", "tests"]
}

Step 5: CLI Entry Point Pattern

#!/usr/bin/env node

import { Command } from "commander";
import chalk from "chalk";

const program = new Command();

program.name("{project-name}").description("{description}").version("1.0.0");

program
  .command("run")
  .description("Primary command")
  .action(async () => {
    // Implementation
  });

program.parse();

Step 6: README Template

Follow the shared conventions in .claude/contracts/shared.md:

  1. Title + one-liner
  2. Badges (MIT, npm, TypeScript, CI)
  3. Demo output / GIF placeholder
  4. Install (npx {name} or npm install -g {name})
  5. Usage (all commands with examples)
  6. How it works
  7. Configuration
  8. Contributing
  9. License
  10. "See Also" — link to 2-3 related Energy tools

Step 7: Verification

pnpm install && pnpm build && pnpm test
node dist/index.js --help
npm pack --dry-run

Output

  • Complete project scaffold ready for implementation
  • All boilerplate handled — builder can focus on core logic
  • Passes npm-publish-checklist from day one

Model Tier

  • Haiku for file generation (steps 1-5)
  • Sonnet for README writing (step 6)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.