Agent skill

Squid Clean Docs

by iusztinpaul in iusztinpaul/squid

Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical.

Apache-2.0Auto-check passedDevelopment

Install Squid Clean Docs

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

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

GitHub CLI
$ gh skill install iusztinpaul/squid squid-clean-docs --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-clean-docs .claude/skills/squid-clean-docs && 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-clean-docs
GitHub stars
203
Token cost
~1.4k tokens
SKILL.md length
554 words
Files
1
Skills in repo
13
Repo updated
First seen
Licence
Apache-2.0

At a glance

Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical.

  • Works in 6 steps: Confirm scope → Apply the keep/delete test → Plan of attack (the output artifact) → …
  • Tasks that involve Technical documentation
  • SKILL.md covers When NOT to use — never touch…, Step 1 — Confirm scope, Step 2 — Apply the keep/delete… and Step 3 — Plan of attack (the…, plus 4 more sections
  • Calls make and git

What it does

Squid Clean Docs is an agent skill from iusztinpaul/squid. Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical.

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/squid-clean-docs”

Workflow steps

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

  1. Confirm scope
  2. Apply the keep/delete test
  3. Plan of attack (the output artifact)
  4. Execute
  5. Verify
  6. Hand-off

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
    • git

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

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    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 Clean Docs loads about 1.4k tokens when it runs. Until then it costs about 30 tokens; SKILL.md has 554 words of instructions outside code blocks.

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

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 passed

The automated check found no risky patterns in SKILL.md.

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). 554 words, ~1,384 tokens.

Download SKILL.mdSave it as .claude/skills/squid-clean-docs/SKILL.md (or your agent's skills folder).
name
squid-clean-docs
description
Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical.
disable-model-invocation
true
argument-hint
[scope-path] (default: whole repo)

Clean docs — remove words, keep behaviour

You are the cleaner. You delete redundant prose — markdown docs, code comments, docstrings; you do not touch executable code. Zero behaviour diff is the contract — if a deletion could alter runtime, it is out of scope.

$ARGUMENTS is an optional scope path (docs/, src/ingest/). Empty means the whole repo.

When NOT to use — never touch these without explicit opt-in

ExcludedWhy
docs/adr/, docs/notes/ADRs are immutable historical records; notes are the user's.
CHANGELOG*, LICENSE*Append-only / legally load-bearing.
.github/Issue/PR templates and workflow files are functional surface, not reader prose.
Generated + vendored trees (node_modules/, .venv/, dist/, vendor/, *_pb2.py)Not authored; regenerated on build.
Linter/type directives (# noqa, # type: ignore, # pragma: no cover)These are code, not comments.
Doctest examples (>>> blocks in docstrings)Executable tests, not prose.

Step 1 — Confirm scope

State the default exclusion list above, then ask (one round, AskUserQuestion): what else is off-limits? Do not scan until answered.

Step 2 — Apply the keep/delete test

Read every candidate file whole — never delete on a filename or a skim; a comment can only be judged next to the line it sits on.

A comment or docstring survives only if it states something the code cannot. A constraint, a non-obvious why, a limit, a workaround and its issue link. If it narrates what the next line does, it is noise — delete it.

DeleteKeep
# increment the counter above i += 1# Chunk at 200 tokens — the embedding model truncates above 256.
A docstring restating the signature: """Takes a user_id and returns a User.""""""Returns None for soft-deleted users; callers must handle it (see #412)."""
# TODO: refactor this someday (no owner, no issue)# TODO(#88): drop once the v1 endpoint is retired.
# Fixed the bug where... — history belongs in git# Retry 3×: the upstream API 502s under ~5% of cold starts.

Docs: a section dies when it duplicates a section that lives elsewhere. Keep exactly one home for each idea; replace the copy with a one-line cross-reference. A README that repeats CONTRIBUTING.md's install steps loses them and links instead.

Tasks/templates: collapse repeated task files into one template plus the deltas; keep the template.

Show full SKILL.md (201 more words)Show less

Step 3 — Plan of attack (the output artifact)

Print one table in chat. Do not write it to disk unless the user asks.

FileWhat goesRule (Step 2)~Lines
src/ingest/chunk.py4 narrating comments, 1 signature docstringrestates code−12
README.mdinstall section duplicating CONTRIBUTING.mdone home per idea−18

Stop and wait for explicit approval. Do not edit before it.

Step 4 — Execute

Apply the approved plan. Commit one category at a time (comments, docs) so any revert is surgical.

Step 5 — Verify

Behaviour must be provably unchanged before hand-off:

  • Test + lint suite green (make pre-commit && make unit-tests, or the project's equivalent) — docstring deletions can break doctests and doc builds.
  • git diff --stat touches only prose and docstrings — no logic lines.
  • No broken internal links: every path, heading, or anchor you deleted or moved has no remaining referrers.

Anything red: revert that commit, do not "fix forward".

Step 6 — Hand-off

Report lines removed per category and the verify result. If the README was reorganised, say what moved where.

Notes on shape

  • Removing beats rewriting. Prefer deleting a paragraph to shortening it.
  • If the caveman plugin is installed, run this first and /caveman-compress after — this decides what exists, that compresses wording.

© 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

Just SKILL.md in skills/squid-clean-docs of iusztinpaul/squid.

Open the folder on GitHubat commit f5bf6b3

Compare with similar skills

Squid Clean Docs 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 Clean Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Squid Clean Docs this skilliusztinpaul/squid203—~1.4kAutomated safety check: PassApache-2.0
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 6 days ago
    DevelopmentAuto-check: notes

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 Clean Docs

What does Squid Clean Docs do?

Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical. Squid Clean Docs is an agent skill from iusztinpaul/squid. Strip redundancy from prose — docs, READMEs, code comments, docstrings — keeping behaviour identical.

When should I use Squid Clean Docs?

Squid Clean Docs fits situations like: tasks that involve Technical documentation.

How do I install Squid Clean Docs in Claude Code?

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

How do I install Squid Clean Docs in Codex?

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

Can I use Squid Clean Docs 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-clean-docs -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-clean-docs, .gemini/skills/squid-clean-docs, .github/skills/squid-clean-docs and .opencode/skills/squid-clean-docs in your project.

What does Squid Clean Docs need to run?

Going by SKILL.md and its folder, Squid Clean Docs needs the command-line tools its instructions call (make and git).

Does Squid Clean Docs access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Squid Clean Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Squid Clean Docs use?

Squid Clean Docs 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 Clean Docs use?

About 1.4k tokens (SKILL.md is roughly 5.5k 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 Clean Docs?

Skills that share tags, products or a category with Squid Clean Docs: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Squid Clean Docs?

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.