# Scaffold Internal Tool

> Initialize an internal-tooling repo — CI, README, pack compliance hooks, no customer surface.

- Skill: `jokerman89/scaffold-internal-tool` (Agent Skill)
- Install (CLI): `npx skillmds@latest add jokerman89/scaffold-internal-tool`
- Raw SKILL.md: https://api.skillmd.com/api/skills/jokerman89/scaffold-internal-tool/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: jokerman89 (https://skillmd.com/u/jokerman89)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/jokerman89/scaffold-internal-tool

---


# /scaffold-internal-tool

Initializes an internal-tooling repo (CLI, dashboard, automation script, ops utility). Distinct from `/scaffold-mvp` (product-grade) and from any customer-bearing scaffold a pack may provide. Internal-tool scaffold is leaner — no customer-voice gates, but it still applies the active pack's compliance hooks (none by default).

## When to use

- New CLI / utility / automation script for the team
- Internal dashboard or monitoring tool
- One-off engineering helper that may evolve into something bigger
- Pre-MVP exploration before deciding whether to productize

## When NOT to use

- Customer-bearing artifact — use `/scaffold-mvp` (or a pack-provided customer-bearing scaffold)
- Adding to existing repo — that's not scaffolding, that's a new module
- Test-only scratch project — overkill

## Inputs

- Required `--name <slug>` — kebab-case name
- Optional `--path <dir>` — where to create (default: cwd / `<name>`)
- Optional `--language <ts|py|go|rs>` — primary language (default: ts)
- Optional `--type <cli|service|dashboard|script>` — tool shape (default: cli)
- Optional `--ci <github|azure-devops|none>` — CI setup (default: github)

## Workflow

1. **Create base structure** (language + type dependent):
   - `cli`: `src/index.ts` + `bin/<name>.js` (or equivalent for other languages)
   - `service`: `src/server.ts` + Dockerfile + health endpoint stub
   - `dashboard`: `src/index.html` + minimal Vite/Next setup
   - `script`: single-file `<name>.{ts,py,go,rs}` + minimal config
2. **Standard files:**
   - `README.md` — purpose, install, usage, contributing
   - `CLAUDE.md` — internal-tool defaults
   - `.gitignore`, `LICENSE` (MIT default)
   - `.editorconfig`
   - `tests/` directory with one starter test
3. **Language-specific:**
   - `ts`: `package.json` + `tsconfig.json` (strict) + `vitest.config.ts`
   - `py`: `pyproject.toml` + `ruff` config + `pytest.ini`
   - `go`: `go.mod` + standard layout
   - `rs`: `Cargo.toml` + `src/main.rs`
4. **CI setup** (if not `--ci none`):
   - `github`: `.github/workflows/ci.yml` with lint + test
   - `azure-devops`: `azure-pipelines.yml`
5. **Compliance pre-wiring:**
   - `compliance/data-class.md` — declares this is internal-tool (no customer-data surface by default)
   - Preferred-vendor baseline (pack-configurable; none by default — no third-party SDKs pre-added)
6. **Git init + first commit.**
7. **Report.**

## Report format

```
Scaffold internal-tool: log-replay-checker

Path: /e/Workspace/log-replay-checker
Language: ts
Type: cli
CI: github

## Created
- src/index.ts, bin/log-replay-checker
- package.json (tsc strict, vitest)
- tsconfig.json (strict mode)
- tests/index.test.ts
- README.md (template populated)
- CLAUDE.md (internal-tool defaults)
- .github/workflows/ci.yml
- compliance/data-class.md (internal-tool default: non-business)

## Next steps
1. Edit src/index.ts — implement the CLI entry
2. Run `npm install` (or your package manager)
3. Edit README.md to describe purpose + usage
4. First test: `npm test`
5. First push: feature branch + PR
```

## Compliance integration

- Pre-declares a data class of non-business (internal-tool default — operator changes if the tool processes higher-sensitivity data).
- Pre-wires a preferred-vendor baseline (pack-configurable; none by default): no third-party SDKs added by default.
- No voice gates (this is internal-tool, no customer surface).

## Failure modes

- **Path exists + not empty:** ask whether to merge or pick new path.
- **Language not supported:** list supported, exit.
- **Type not supported:** list valid types, exit.
- **CI selected but template missing for that platform:** fall back to none + warn.
- **Package manager not installed:** create files, skip install, surface manual next steps.

## Examples

**TypeScript CLI:**
```
> /scaffold-internal-tool --name log-replay-checker --language ts --type cli
✓ Scaffolded. Run `npm install` then implement src/index.ts.
```

**Python script:**
```
> /scaffold-internal-tool --name daily-status-emitter --language py --type script --ci azure-devops
✓ Scaffolded with Azure Pipelines CI.
```

**Go service:**
```
> /scaffold-internal-tool --name metrics-aggregator --language go --type service
✓ Scaffolded with Dockerfile + health endpoint.
```

## See also

- `/scaffold-mvp` — for product-grade scaffolds
- `/health` — validate scaffolded structure post-creation