agentleFS
specscorespecscore/specstudio-skills/skills/init/SKILL.md

init

Skill0 starsChanged 5 months agoMITView on GitHub

Bootstraps a SpecScore-managed project in one wizard-driven step. Detects current project state by direct repo inspection, asks 3-4 batched wizard questions with defaults pre-filled from detection, then idempotently scaffolds: specscore.yaml + spec/{,ideas,features}/README.md (via `specscore init` only — the CLI scaffold is the single source of truth; no hand-scaffold fallback), and pastes the canonical Producer-shape instruction snippet into the right platform agent-instructions file. Two modes: default (full wizard) and `--update` (drift-only reconciliation, no wizard). Delegates CLI installation to `specscore:install`. Trigger: "specstudio:init", "/specstudio:init", "set up specstudio", "bootstrap a spec repo".

  • Pipes a download into a shell
  • Installs packages

137 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use daily-arxiv, exp-eval and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • LambenthanSkill

    daily-arxiv

    每日从 arXiv 拉取新论文,过滤相关性,auto-ingest 高优先级论文,检测 SOTA 更新

    Also in 5 projects that use this

  • LambenthanSkill

    exp-eval

    实验判决门:Review LLM 独立评判实验结果 → 4 种判决路径 → 自动更新 claims confidence、ideas status、graph edges

    Also in 5 projects that use this

  • skyllwtSkill

    exp-pilot-eval

    Pilot result evaluation — read pilot results, apply success criteria, update idea page (pilot_result, failure_reason if failed), generate PILOT_VERDICT_REPORT. Called by /ideate Phase 5 after /exp-pilot-run.

    Also in 4 projects that use this

  • skyllwtSkill

    exp-pilot-run

    Pilot experiment execution — read Pilot Spec YAML, write pilot code, run experiment(Confirm with the user before operation and require the applicant to conduct manual inspection), return results. Called by /ideate Phase 5. Does NOT modify wiki pages or judge pass/fail.

    Also in 4 projects that use this

  • gaebalaiSkill

    codex-system

    PROACTIVELY consult Codex CLI, your highly capable supporter with exceptional reasoning and task completion abilities. Codex is a trusted expert you should ALWAYS consult BEFORE making decisions on: design choices, implementation approaches, debugging strategies, refactoring plans, or any non-trivial problem. When uncertain, consult Codex. Don't hesitate - Codex provides better analysis. Explicit triggers: "think deeper", "analyze", "second opinion", "consult codex".

    Also in 3 projects that use this

  • +6 more from Lambenthan
  • +1 more from skyllwt

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. 0 are common, 9 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 125 edited versions we read keep these.

  • 9

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Skip: when: the project is fully initialized AND no drift is detected.

    line 37
  2. Distinctive:

    Update mode MUST NOT scaffold new artifacts.

    line 53
  3. Distinctive:

    Before any user-facing prompt, inspect the repo to record:

    line 57
  4. Distinctive:

    Use the result to drive the rest of the flow:

    line 68
  5. Very specific:

    After return → re-branch on specscore --version.

    line 82
  6. Very specific:

    Greenfield confirmation: When state detection finds non-trivial pre-existing structure (e.g., a docs/ tree with what look like spec …

    line 96
  7. Very specific:

    If CLAUDE.md exists AND its content references AGENTS.md (literal AGENTS.md mention, @AGENTS.md import, or "see AGENTS.md" pointer) → …

    line 105
  8. Very specific:

    Use --force only when state detection found an existing specscore.yaml AND the user explicitly opted into overwriting it.

    line 120
  9. Distinctive:

    If state detection found the snippet already pasted at the canonical version, skip Step 5 entirely.

    line 131
  10. Distinctive:

    When state detection finds an existing snippet at a version different from canonical:

    line 143
  11. Distinctive:

    Ask the user to choose:

    line 147
  12. Distinctive:

    After all bootstrap steps complete:

    line 157
  13. Very specific:

    When the skill creates files (via specscore init, snippet install), stage the affected paths with git add and report the staged paths to …

    line 177
  14. Distinctive:

    If the project root is not a git repository, surface "not a git repository — skipping auto-stage.

    line 179

“Common” is measured: kept by at least 6 in 10 of the 125 edited versions of this file we could read. “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

Init

Bootstrap a SpecScore-managed project — specscore.yaml, spec/ tree, snippet pasted — in one wizard.

Hard Gate

<HARD-GATE> This skill writes files outside `spec/` (the canonical instruction-file paste targets `CLAUDE.md` / `AGENTS.md` / `GEMINI.md`, optionally `.gitignore`). Every such write MUST go through an explicit per-write user-consent prompt. The skill MUST NOT silently overwrite user content. The skill MUST NOT install CLIs itself — install delegation goes to `specscore:install`, and only after the user consents.

Non-default mode: --update. In update mode the skill MUST NOT scaffold anything — only diff and reconcile drift on already-managed artifacts. If the project is not yet initialized, update mode reports "not initialized" and refuses, redirecting to default mode. </HARD-GATE>

When to Use

  • A user wants to bootstrap a SpecScore-managed project (greenfield or brownfield).
  • An existing SpecScore project's snippet has drifted from the canonical version (e.g., the SpecStudio repo shipped a snippet update; adopters need to reconcile). Use --update.
  • An existing project is partially initialized (e.g., spec/ideas/ exists from a previous ideate run, but no specscore.yaml). The skill resumes the missing pieces without erroring.

Skip when: the project is fully initialized AND no drift is detected. The skill detects this state and exits cleanly with "already initialized; nothing to do" — no wizard, no event.

Two operational modes

The mode is determined by invocation argument, not by detected state.

Default mode — specstudio:init

Full wizard flow: state detection → CLI prerequisite check + install delegation → 3–4-question wizard → bootstrap actions (specscore init) → snippet install with consent → event emission.

Greenfield AND brownfield repos both flow through this mode; brownfield reuses defaults derived from detected state.

Update mode — specstudio:init --update

Drift-only flow: state detection → no wizard → check each managed artifact (snippet pasted in agent-instructions file, specscore.yaml schema header, spec/ indexes) for drift against the canonical version → on drift, present diff and ask the user to replace / keep / abort per artifact.

Update mode MUST NOT scaffold new artifacts. If a managed artifact is missing entirely, update mode reports "not initialized" and refuses, redirecting to default mode.

Step 1 — State detection (always runs first)

Before any user-facing prompt, inspect the repo to record:

  • git_initialized — does git rev-parse --git-dir succeed?
  • spec_tree_status — does spec/, spec/ideas/, spec/features/ exist? Are their README.md files lint-clean per specscore spec lint?
  • specscore_yaml_status — does <root>/specscore.yaml exist? If yes, is line 1 the canonical schema-pointer comment?
  • agent_instruction_files — for each of CLAUDE.md, AGENTS.md, GEMINI.md, files under .cursor/rules/, record whether the file exists at repo root (or under .cursor/rules/).
  • snippet_versions_per_file — for each existing agent-instructions file, scan for the snippet block (delimited by the version comment). If found, record the version. If absent, record none.
  • cli_versions — branch on specscore --version per shared/cli-detection.md (Wizard-class row): exit 0 → record present with the parsed version; 127 → record missing. Do not use a standalone command -v probe.

No state file. Detection is via filesystem inspection only — never via a hidden .specstudio/init-state.yaml or similar. The repo's actual state IS the state.

Use the result to drive the rest of the flow:

  • All-clean → exit no-op (skip condition).
  • Partial state (missing some artifacts) → resume.
  • Drift (existing snippet at older version) → reconcile in update mode; in default mode, surface during wizard.
  • Greenfield (nothing initialized) → full bootstrap.

Step 2 — CLI prerequisite check & install delegation

If specscore is missing, ask explicit consent before delegating to its install skill. The install delegation runs at most once per invocation. The scaffold in Step 4 hard-requires the CLI — there is no hand-scaffold fallback — so the cold-start path (brand-new repo, no CLI) is handled here by install-then-retry, not by hand-writing artifacts.

specscore missing:

  1. Surface to user: "specscore is not on PATH. Invoke specscore:install to install it now? (yes / no)"
  2. On yes → invoke the specscore:install skill via the platform's skill-invocation mechanism (Claude Code Skill tool, or equivalent). Wait for return.
  3. After return → re-branch on specscore --version. If exit 0, continue. If still 127, abort with "specscore install completed but binary still not on PATH; check PATH or open a new shell, then re-run init."
  4. On no → stop with "specstudio:init scaffolds via the specscore init CLI, which is required and has no hand-scaffold fallback. Install it (/specscore:install), then re-run init." Do not hand-write any artifacts.

Step 3 — Wizard (default mode only)

Skip in --update mode and in the all-clean skip condition.

Use a single batched AskUserQuestion call. Maximum four questions. Each question carries a default derived from state detection; the default is visible to the user before they answer. Questions whose answer is unambiguous from detected state (e.g., only one platform agent-instructions file exists → no need to ask which to target) are skipped, not asked with a forced default.

The fixed four:

  1. Platform agent-instructions target. Which file to install the canonical snippet into. Skipped when only one platform file exists. Apply the platform-detection rule below.
  2. Optional spec subdirectories. Single batched question presenting both spec/research/ and spec/decisions/ with their visible defaults (decisions=yes, research=no). Implementation note: today the specscore init CLI does NOT scaffold these (out of MVP scope upstream), so the skill defers them until upstream Indexes ship. Do not create placeholder directories or indexes by hand.
  3. Custom viewer. Whether to register a non-default viewer: block in specscore.yaml. Default: no (Repo Config defaults apply).
  4. Greenfield confirmation. When state detection finds non-trivial pre-existing structure (e.g., a docs/ tree with what look like spec artifacts), confirm before scaffolding. Skipped when greenfield is unambiguous.

Platform-detection rule for the snippet install step

This rule is canonical for SpecStudio (the third-party-integration Feature explicitly defers to it):

  1. No agent-instructions file present → ask the user which to create from the canonical paste-target list (CLAUDE.md, AGENTS.md, GEMINI.md, or .cursor/rules/specstudio.md).
  2. Exactly one agent-instructions file present → target it.
  3. Multiple agent-instructions files present. Inspect contents:
    • If CLAUDE.md exists AND its content references AGENTS.md (literal AGENTS.md mention, @AGENTS.md import, or "see AGENTS.md" pointer) → target only AGENTS.md (CLAUDE.md is a redirect).
    • Otherwise → ask the user which to update (with multi-select option to update all).

Step 4 — Bootstrap via specscore init (required; no fallback)

specscore init is the only scaffolding path. This step follows the Required-CLI Artifact Creation policy in shared/cli-detection.md (Creation-class row): the CLI scaffold is the single source of truth for specscore.yaml and the spec/ indexes, and the skill never hand-scaffolds them.

The CLI is a black box. The skill does not depend on HOW specscore init produces the files — it makes no template-sourcing assumptions and does not read, mirror, or reconstruct the CLI's output shape. It invokes the command and inspects the result; that is all.

Invoke specscore init as a subprocess from the project root, passing the wizard's resolved answers as documented CLI flags:

specscore init --project <root> [--title <title>] [--host <host>] [--org <org>] [--repo <repo>] [--force]

Use --force only when state detection found an existing specscore.yaml AND the user explicitly opted into overwriting it. Never invent flags specscore init does not document; if a wizard answer has no matching flag, write that field via Edit after the CLI returns.

Capture stdout/stderr/exit-code and branch on the exit status (no command -v probe) per the Creation-class row in shared/cli-detection.md (which carries the per-outcome rationale):

  • exit 0 → scaffold succeeded; continue.
  • 127 → install message (/specscore:install), then install-then-retry: on consent, delegate to specscore:install (Step 2 mechanism, at most once per invocation) and re-run specscore init. This is the cold-start path (brand-new repo, no CLI) — never a hand-scaffold.
  • exit 8 → upgrade-then-retry, naming the missing init subcommand: on consent, re-run specscore init after the upgrade.
  • any other non-zero → surface the error cleanly; never a hand-written fallback.

Step 5 — Snippet installation (canonical Producer-shape snippet)

If state detection found the snippet already pasted at the canonical version, skip Step 5 entirely.

Otherwise:

  1. Read the canonical snippet from spec/features/third-party-integration/snippet.md in the project. If the file does not exist (the SpecStudio version in use has not yet shipped the snippet artifact), report "snippet not yet shipped at <path>; skipping snippet install" and continue with subsequent steps. This is graceful degradation — not an error.
  2. Apply the platform-detection rule from Step 3 to determine the target file.
  3. Display to the user: (a) the snippet content (or a length-bounded summary if longer than 50 lines), (b) the target file path, (c) the action ("append at end of file" for new install, "replace existing snippet block" for drift reconciliation), and (d) an explicit consent prompt: "Install / replace the snippet at this path? (yes / no)".
  4. On yes → write atomically (single-file write). The pasted snippet MUST preserve the embedded <!-- specstudio-snippet-version: <semver> --> comment unmodified — that comment is what --update mode uses to detect drift on subsequent runs.
  5. On no → skip snippet install with "snippet not installed; you can re-run specstudio:init --update later". Continue with subsequent steps (snippet install is independent of orchestration setup).

Drift reconciliation (--update mode or default-mode rerun)

When state detection finds an existing snippet at a version different from canonical:

  1. Display a unified diff between pasted and canonical.
  2. Display the canonical version's changelog if available (currently: just the version increment).
  3. Ask the user to choose:
    • replace — overwrite the pasted block with the canonical
    • keep — leave the pasted block as-is; report drift but do not act
    • abort — exit init without writing
  4. On replace → write atomically. The skill MUST NOT auto-merge.

The skill MUST NOT distinguish between "version drift" and "user-edit drift" — both prompt the same diff-and-confirm flow.

Step 6 — Event emission

After all bootstrap steps complete:

  • First successful greenfield init (state detection found nothing initialized; bootstrap created specscore.yaml AND at least one index AND optionally the snippet): emit project.initialized exactly once. Payload includes project_id (slug derived from project.repo), revision (current git SHA after staging), cli_versions (object with the specscore version), snippet_target_file (path or null if skipped), artifacts_created (list of paths written this invocation).
  • Subsequent state-changing run (--update resolving drift, default-mode rerun resuming partial bootstrap, snippet replacement): emit project.updated. Payload mirrors project.initialized plus change_summary (≤2 factual sentences).
  • No-op rerun (skip condition triggered, nothing changed): emit no event.

The skill MUST NOT emit project.initialized more than once per project; subsequent state-changing runs always emit project.updated.

Idempotence

Re-running specstudio:init (default mode) MUST be safe:

  • Fully-initialized + no drift → no-op (skip condition; no wizard, no writes, no event).
  • Partial state → resume; create missing pieces; preserve existing pieces byte-identical.
  • Drift detected → present via the diff-and-confirm flow; never silently update.

The skill MUST NOT distinguish "user-edit drift" from "version drift" — both use the same prompt: "the file differs from canonical; what do you want to do?"

Auto-stage in git

When the skill creates files (via specscore init, snippet install), stage the affected paths with git add and report the staged paths to the user in the same response. Never commit on the user's behalf — commits are the user's call.

If the project root is not a git repository, surface "not a git repository — skipping auto-stage; you can git init if you want versioned spec history" and continue.

Tone

Direct, helpful, honest about partial states and degraded paths. The skill is a wizard; the user is the operator. Show what's about to happen before it happens; ask permission for everything outside spec/.

Red Flags

  • Running install commands directly (brew install, curl | sh) instead of delegating to specscore:install.
  • Writing to agent-instructions files (CLAUDE.md, etc.) without explicit per-write consent.
  • Silent overwrite of user content on rerun.
  • Emitting project.initialized more than once for the same project.
  • Inventing specscore init flags that don't exist.
  • Bundling multiple unrelated writes behind a single consent prompt.
  • Distinguishing "user-edit drift" from "version drift" in any user-facing way (both are the same prompt).
  • Creating a state file (.specstudio/init-state.yaml, .specscore/init.lock) for idempotence; the filesystem IS the state.
  • Treating "not a git repository" as an error instead of a graceful skip-auto-stage condition.

Verification

  • State detection ran before any user-facing prompt
  • Skip condition (fully initialized + no drift) exits no-op without event
  • CLI install delegation went to specscore:install, not direct install commands
  • Wizard asked at most 5 batched questions with defaults visible
  • specscore init is the only scaffolding path; on 127 it offers install-then-retry (no hand-scaffold fallback)
  • Scaffold step treats the CLI as a black box and cites shared/cli-detection.md
  • Snippet install displayed snippet + target + action, then waited for consent
  • Pasted snippet preserved the version comment unmodified
  • Drift detection used diff-and-confirm; no auto-merge
  • project.initialized emitted at most once per project
  • project.updated emitted on subsequent state-changing runs
  • No event on no-op rerun
  • No state file created for idempotence
  • Files created were git add'd (when project is a git repo) and never committed

References

  • spec/features/skills/init/ — the Feature spec this skill implements
  • spec/features/third-party-integration/ — the Feature defining the canonical snippet and the platform-detection rule
  • spec/features/third-party-integration/snippet.md — the canonical Producer-shape instruction snippet this skill installs
  • SpecScore Repo Config Feature — the schema specscore.yaml conforms to
  • SpecScore CLI init Feature — the specscore init subcommand contract this skill delegates to
  • specscore:install — install delegate for the specscore CLI
  • shared/events.md — event vocabulary project.initialized / project.updated participate in

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.