Agent skill

Squid Scaffold

by iusztinpaul in iusztinpaul/squid

Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only).

Apache-2.0Auto-check: notesDevelopment

Install Squid Scaffold

skills CLI
$ npx skills add iusztinpaul/squid --skill squid-scaffold -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install iusztinpaul/squid squid-scaffold --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/iusztinpaul/squid.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/squid-scaffold .claude/skills/squid-scaffold && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
squid-scaffold
GitHub stars
203
Token cost
~2.8k tokens
SKILL.md length
1,080 words
Files
50
Skills in repo
13
Repo updated
First seen
Licence
Apache-2.0

At a glance

Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only).

  • Works in 5 steps: Gather requirements → Select specs → Compose AGENTS.md → …
  • Tasks that involve Project scaffolding
  • SKILL.md covers Modes, When to use, When NOT to use and Flow
  • Calls make; reaches pydantic.dev

What it does

Squid Scaffold is an agent skill from iusztinpaul/squid. Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only).

Its SKILL.md is about 2.8k tokens, which your agent loads only when the skill is triggered. The skill folder holds 50 other files (for example `AGENTS_TEMPLATE.md`, `evaluate.md` and `rules.md`).

It sits in Development, covering Project scaffolding. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Project scaffolding

Example prompts

  • “/squid-scaffold”

Requirements

  • Python 3
  • Docker

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Gather requirements
  2. Select specs
  3. Compose AGENTS.md
  4. Create the folder skeleton
  5. Report back

What it can do on your machine

Read from SKILL.md and the folder at commit f5bf6b3. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • make

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • pydantic.dev

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Squid Scaffold loads about 2.8k tokens when it runs. Until then it costs about 50 tokens; SKILL.md has 1,080 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~50
When it runs · the whole SKILL.md, loaded when a task matches
~2.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:119
    odules/`, `dist/`, `bin/`, `.DS_Store`, `.env`). Do **not** ignore `.claude/skills` or `.agents/` — the symlink and its

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from iusztinpaul/squid at commit f5bf6b3, republished under its Apache-2.0 licence (© iusztinpaul). 1,080 words, ~2,777 tokens.

Download SKILL.mdSave it as .claude/skills/squid-scaffold/SKILL.md (or your agent's skills folder). This skill also uses 49 other files; get the full folder from GitHub.
name
squid-scaffold
description
Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only).
disable-model-invocation
true
argument-hint
[mode=create|evaluate] [project description | target repo path]

Scaffold

Interactive bootstrap for a new repo (or a new component in an existing one): read only the specs under specs/ that apply, distil them into a tailored AGENTS.md, lay down an empty skeleton, hand back.

Modes

$ARGUMENTS may lead with mode=create (default) or mode=evaluate:

  • mode=create (default) — bootstrap a repo / component. The flow in "## Flow" below.
  • mode=evaluate — audit an existing scaffolded repo for drift (report-only). For mode=evaluate, read evaluate.md and follow E1–E4 instead of the Flow.

Every rule both modes honour lives in rules.md — the single source of truth; mode=create follows every P# + I# while composing, mode=evaluate audits the I#. Do not restate any rule in this file.

When to use

  • Bootstrapping a brand-new repo.
  • Adding a new runtime component (backend / frontend-web / frontend-tui) to an existing scaffolded repo.
  • Re-generating the root AGENTS.md after a major stack change (e.g. swapping Vue for React).

When NOT to use

  • Authoring application source or business logic (P1).
  • Adjusting opinions inside an existing project — edit the generated AGENTS.md directly.
  • Non-polyglot single-package projects where the full machinery is overkill. (You can still use a single spec as reference, but skip the scaffold flow.)

Flow

1. Gather requirements

Use AskUserQuestion to collect answers. Consolidate where possible — one or two prompts, not a twelve-step interview. Minimum set:

  1. Project identity — name, short description, license (MIT / Apache-2.0 / proprietary). Name becomes the repo / root AGENTS.md title; slug is derived.
  2. Layout — monorepo (packages/<c>/ tree) or standalone single-package?
  3. Components (multi-select; at least one required):
    • backend — Python service / pipeline / library
    • frontend-web — TypeScript browser SPA
    • frontend-tui — Go terminal UI
  4. Backend variant (if backend chosen): fastapi-service / fastmcp-server / cli-tool-python / library-only.
  5. Frontend-web framework (if frontend-web chosen): react / vue / svelte / vanilla.
  6. Frontend-tui framework (if frontend-tui chosen): bubbletea (default) / tview.
  7. Shared OpenAPI contracts (only if backend + ≥1 frontend): yes / no.
  8. Infra (multi-select): docker, github-actions, pre-commit-hooks.
  9. Agent team + tracker? yes (recommended) / no. Also: file-based tracker or GitHub Issues?
  10. Process & documentation (multi-select, optional): adr (Architecture Decision Records under docs/adr/), ubiquitous-language (project glossary at docs/glossary.md). Recommend adr for any project expected to live > 6 months; recommend ubiquitous-language for backend services with named domain entities.
  11. External services (optional, multi-select — skip any category that doesn't apply). Each selection pulls a specs/<category>-<choice>.md stub and emits a one-line bullet into the generated AGENTS.md, wrapped per I9:
  • Datastore: mongodb / postgresql / redis / sqlite / other / none
  • Orchestrator: prefect / dagster / temporal / other / none
  • Observability & evals: opik / opentelemetry / sentry / other / none
  • LLM API: anthropic / openai / gemini / other / none
  • Embedding API: voyageai / openai / sentence-transformers / other / none
  • Model serving: modal / replicate / other / none
  • Web scraping: firecrawl / playwright / requests-bs4 / other / none

Ask this as ONE consolidated question: "Which external services will you use? (deselect anything you don't need)." none skips the category entirely — no stub read, no bullet emitted. other keeps an AGENT: fill in placeholder so the SWE can document the real choice on first use.

  1. Reference docs (llms.txt) — which tools / frameworks / services publish an llms.txt, and each one's index URL (e.g. Pydantic AI → https://pydantic.dev/docs/ai/llms.txt)? Governed by P5; fully skippable.

Before proceeding to step 2, echo the picked configuration back to the user in a two-line summary and confirm.

2. Select specs

Always include:

Conditionally include (from answers):

AnswerSpecs to read
backend (any variant)python-backend.md + uv-python.md + pyproject.md + ruff-python.md
backend = fastapi-service+ fastapi-service.md
backend = fastmcp-server+ fastmcp-server.md
backend = cli-tool-python+ cli-tool-python.md
frontend-webtypescript-frontend.md + the chosen framework spec (react-app.md / vue-app.md / svelte-app.md / vanilla-ts-app.md)
frontend-tuigo-tui.md (already covers both bubbletea and tview)
shared OpenAPI contractsopenapi-contracts.md
dockerdocker.md
github-actionsgithub-actions.md
pre-commit-hookspre-commit-hooks.md
agent team + trackertracker-workflow.md
process: adradr.md
process: ubiquitous-languageubiquitous-language.md
datastore = mongodb / postgresql / redis / sqlite+ datastore-<choice>.md
orchestrator = prefect / dagster / temporal+ orchestrator-<choice>.md
observability = opik / opentelemetry / sentry+ observability-<choice>.md
llm-api = anthropic / openai / gemini+ llm-<choice>.md
embeddings = voyageai / openai / sentence-transformers+ embeddings-<choice>.md
model-serving = modal / replicate+ model-serving-<choice>.md
scraping = firecrawl / playwright / requests-bs4+ scraping-<choice>.md

Skip any row where the user picked none / other. Read each selected spec end-to-end.

Show full SKILL.md (496 more words)Show less
3. Compose AGENTS.md

Write the project's root memory file from the canonical template in AGENTS_TEMPLATE.md (the template body and section structure). Compose it following the I# artifact invariants in rules.md. Read both end-to-end, then emit a tailored AGENTS.md at the target project root (or wherever /squid-scaffold was invoked).

Optional — compress with caveman. If the caveman plugin is installed, offer to run /caveman-compress AGENTS.md on the composed file (ask first — the result is terser to hand-edit). Skip silently when caveman isn't installed.

4. Create the folder skeleton

Create these files / directories, empty or with minimal placeholders (P1).

Always:

  • AGENTS.md — from step 3.
  • CLAUDE.md — relative symlink to AGENTS.md (I4).
  • .agents/skills/ (seeded with .gitkeep) and .claude/skills — relative symlink to it (I12).
  • README.md — one-paragraph project-facing intro pointing at AGENTS.md.
  • .gitignore — language-appropriate (.venv/, node_modules/, dist/, bin/, .DS_Store, .env). Do not ignore .claude/skills or .agents/ — the symlink and its target are committed.
  • .env.example — cross-cutting placeholder keys (one commented sample var).

If monorepo:

  • Root Makefile and per-component packages/<c>/Makefile — generate from makefile-delegator.md for the chosen components (I10). Write a working first-pass Makefile, not AGENT: fill in stubs: the verbs are mechanical, the tooling is standard per language, and make install && make test must work on the fresh scaffold. Real-code placeholders still apply to src/, not to the Makefile.

  • Each packages/<c>/ also gets:

    • AGENTS.md — one-paragraph component brief + "see root AGENTS.md for conventions"; plus a CLAUDE.md symlink to it (I4).
    • .env.example — component-local placeholder.
    • No source files (P1).
  • If shared OpenAPI chosen: packages/shared/openapi/api.yaml with a minimal /health endpoint seed.

If docker chosen:

  • docker-compose.yml — one service block per runtime component with AGENT: fill in placeholders for image / ports / healthcheck.
  • Component-level Dockerfile stub with AGENT: fill in multi-stage build.

If github-actions chosen:

  • .github/workflows/ci.yml — umbrella workflow with dorny/paths-filter routing.
  • .github/workflows/ci-<c>.yml — one reusable workflow stub per component.
  • .github/dependabot.yml — one ecosystem per component.

If agent team + tracker chosen:

If adr chosen (Process & documentation):

  • docs/adr/0001-record-architecture-decisions.md — drop the canonical ADR-0001 boilerplate verbatim from adr.md's Bootstrap section, with {YYYY-MM-DD} replaced by today's date. This is the only ADR scaffold writes — subsequent ADRs are authored by the PA during /squid-plan grooming as decisions arise. Do not emit a docs/adr/.gitkeep (ADR-0001 already keeps the directory non-empty).

If ubiquitous-language chosen (Process & documentation):

  • docs/glossary.md — this seed, verbatim. Do not invent domain terms — the SWE / PA populate it as the first feature lands.

    markdown
    # Glossary
    
    The canonical vocabulary for {project name}. When code, docs, specs, or conversation use a domain concept, use the term as it appears here. PRs that introduce or rename a domain concept update this file in the same change.
    
    | Term | Definition | Notes |
    |---|---|---|
    <!-- | **OrderLine** | One line item within an Order, identified by `order_line_id`. | Distinct from "Item" (the catalogue entry). | -->
5. Report back

Summarise for the user:

  • File tree created (full list, relative paths).
  • Which specs informed the AGENTS.md (named).
  • Exact next step — e.g. /squid-implement-task "bootstrap packages/backend with a minimal FastAPI app and a /health endpoint". The SWE agent will read AGENTS.md and the spec references, and write the first real code.

© iusztinpaul, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 49 other files in skills/squid-scaffold of iusztinpaul/squid.

  • SKILL.md
  • AGENTS_TEMPLATE.md
  • evaluate.md
  • rules.md
  • specs/README.md
  • specs/adr.md
  • specs/cli-tool-python.md
  • specs/datastore-mongodb.md
  • specs/datastore-postgresql.md
  • specs/datastore-redis.md
  • specs/datastore-sqlite.md
  • specs/docker.md
  • specs/embeddings-openai.md
  • specs/embeddings-sentence-transformers.md
  • specs/embeddings-voyageai.md
  • specs/fastapi-service.md
  • specs/fastmcp-server.md
  • specs/github-actions.md
  • specs/go-tui-bubbletea.md
  • specs/go-tui-tview.md
  • … and 30 more

Open the folder on GitHubat commit f5bf6b3

Compare with similar skills

Squid Scaffold next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Squid Scaffold compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Squid Scaffold this skilliusztinpaul/squid203—~2.8kAutomated safety check: NotesApache-2.0
Nx Generatenomcopter/react-mosaic4.8k7 repos~1.9kAutomated safety check: PassCustom licence
PonytailDavidObando/gsharp5657 repos~1.7kAutomated safety check: PassMIT
Run Nx Generatornrwl/nx29k2 repos~592Automated safety check: NotesMIT
Conductor Setupgemini-cli-extensions/conductor3.8k—~4.2kAutomated safety check: PassApache-2.0
Mirage VFS Adapter Authoringstrukto-ai/mirage3.7k—~2.5kAutomated safety check: PassApache-2.0

Similar skills

  • Nx Generate

    nomcopter/react-mosaic

    Generate code using nx generators. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Ponytail

    DavidObando/gsharp

    Forces the laziest solution that actually works, simplest, shortest, most minimal.

    565 GitHub starsUsed in 7 repos~1.7k tokens
    DevelopmentAuto-check passed
  • Run Nx generators with prioritization for workspace-plugin generators.

    29k GitHub starsUsed in 2 repos~592 tokens
    DevelopmentAuto-check: notes
  • Conductor Setup

    gemini-cli-extensions/conductor

    Scaffolds the project and sets up the Conductor environment.

    3.8k GitHub stars~4.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Builds or extends a custom Mirage virtual filesystem adapter for an API, database, object store or app data, with a working mount configuration and filesystem tests.

    3.7k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Enforces this repository's TypeScript backend module architecture under server/: feature folders, barrel exports, and where shared types and utilities belong.

    14k GitHub stars~1.2k tokensUpdated today
    DevelopmentAuto-check passed

More from iusztinpaul/squid

All 13 skills in this repo
  • Squid Implement Night

    iusztinpaul/squid

    Run the full agent-team pipeline end-to-end for one feature whose Tasks Plan is already approved by /squid-plan, handing the human a validated, ready-to-squash-merge PR.

    203 GitHub stars~1.2k tokensUpdated 1 mo ago
    Auto-check passed
  • Squid Implement Task

    iusztinpaul/squid

    Implement one task — or a whole list / an approved Tasks Plan — via the inner SWE↔Tester loop, committing each task on PASS.

    203 GitHub stars~1.3k tokensUpdated 1 mo ago
    Auto-check passed
  • Squid Review

    iusztinpaul/squid

    Push the committed feature branch, create or update its PR, then run Product Architect acceptance and PR-Reviewer on it.

    203 GitHub stars~873 tokensUpdated 1 mo ago
    Auto-check passed
  • Squid Review CI

    iusztinpaul/squid

    Drive CI green on a pushed, review-clean feature PR — On-Call diagnoses failures and hands fix tasks to the SWE.

    203 GitHub stars~607 tokensUpdated 1 mo ago
    Auto-check passed
  • Squid Testing Python

    iusztinpaul/squid

    Write and evaluate effective Python tests using pytest. An agent skill from iusztinpaul/squid.

    203 GitHub stars~1.3k tokensUpdated 1 mo ago
    Auto-check passed
  • Squid Architecture Review

    iusztinpaul/squid

    Periodic architectural sweep — reads existing ADRs, maps modules/dependencies/layering, and reports up to 10 prioritised findings shaped as refactor proposals /squid-refactor can consume directly.

    203 GitHub stars~2.6k tokensUpdated 1 mo ago
    Auto-check passed

Categories

Questions about Squid Scaffold

What does Squid Scaffold do?

Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only). Squid Scaffold is an agent skill from iusztinpaul/squid. Bootstrap a new repo or component from the opinionated spec library (mode=create), or audit an existing scaffolded repo for drift against the scaffold rules (mode=evaluate, report-only).

When should I use Squid Scaffold?

Squid Scaffold fits situations like: tasks that involve Project scaffolding.

How do I install Squid Scaffold in Claude Code?

Run `npx skills add iusztinpaul/squid --skill squid-scaffold -a claude-code`. Or copy the skill folder (skills/squid-scaffold in iusztinpaul/squid) into .claude/skills/squid-scaffold in your project. Claude Code loads it when a task matches its description.

How do I install Squid Scaffold in Codex?

Run `npx skills add iusztinpaul/squid --skill squid-scaffold -a codex`. Or copy the skill folder (skills/squid-scaffold in iusztinpaul/squid) into .agents/skills/squid-scaffold in your project. Codex loads it when a task matches its description.

Can I use Squid Scaffold in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add iusztinpaul/squid --skill squid-scaffold -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/squid-scaffold, .gemini/skills/squid-scaffold, .github/skills/squid-scaffold and .opencode/skills/squid-scaffold in your project.

What does Squid Scaffold need to run?

Going by SKILL.md and its folder, Squid Scaffold needs the command-line tools its instructions call (make). Our summary lists: Python 3; Docker.

Does Squid Scaffold access the network?

SKILL.md names 1 domain. In commands or code: pydantic.dev; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Squid Scaffold safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Squid Scaffold use?

Squid Scaffold is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Squid Scaffold use?

About 2.8k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Squid Scaffold?

Skills that share tags, products or a category with Squid Scaffold: Nx Generate (nomcopter/react-mosaic, 4.8k stars), Ponytail (DavidObando/gsharp, 565 stars), Run Nx Generator (nrwl/nx, 29k stars) and Conductor Setup (gemini-cli-extensions/conductor, 3.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Squid Scaffold?

iusztinpaul (a GitHub user) maintains it in iusztinpaul/squid, which has 203 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on September 3, 2026.

Source: iusztinpaul/squid on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.