Skip to content

README.md

Latest commit

 

History

History
105 lines (64 loc) · 3.82 KB

README.md

File metadata and controls

105 lines (64 loc) · 3.82 KB
Raw

After "Use this template": apply the Coal*-skill overlay with node .github/scripts/new-repo.mjs published-code --overlay coal-skill --name <repo> --license <spdx> <target-dir> from a clone of TheColliery/.github, or run new-repo.mjs directly to scaffold instead of using the GitHub UI button — either path fills the same {{PLACEHOLDER}} tokens.

{{EMOJI}} {{REPO_NAME}}

{{ONE_SENTENCE_TAGLINE}}

{{ONE_SENTENCE_WHAT_IT_DOES}}

version license status

Changelog · Security · Privacy · Releases

What it is

{{WHAT_IT_IS}}

How it works

{{HOW_IT_WORKS}}

Compatibility

Platform Support
Claude Code {{TIER}}

Install

{{INSTALL_COMMAND}}

{{OTHER_AGENT_INSTALL_PATH}}

Commands

Command What it does
{{COMMAND}} {{WHAT_IT_DOES}}

Configure

Every tool supports TWO config levels — a global ~/.claude/.{{TOOL_KEY}}.json and a per-project .{{TOOL_KEY}}.json override (project wins) — so a globally-installed skill can be tuned or shut off per project ({{OFF_SWITCH_KEY}}: false).

Key Default What it does
{{KEY}} {{DEFAULT}} {{WHAT_IT_DOES}}

Full key reference: scripts/lib/config-schema.mjs + the commented platform-configs/ template.

Permissions

{{REPO_NAME}} {{WHAT_IT_REQUESTS}}. It never {{WHAT_IT_NEVER_REQUESTS}}. Workers get strictly less than main — no spawning, no prompting you directly.

Permission Matrix

Benchmark

{{BENCHMARK_ONE_LINE_HONEST_FRAMING}} — see .github/benchmarks/{{REPO_NAME}}/.

Part of TheColliery

{{REPO_NAME}} is {{ROLE_IN_SERIES}}:

Install one and it stands alone; {{COMPOSE_PROMISE}}. Every tool in the series shares Phoenix-13 hooks, a single-source-of-truth config, and a no-overkill design bar.

{{OFFLINE_CLAIM_IF_TRUE}}

License

{{LICENSE_STATEMENT}} See LICENSE.