Ir al contenido

Command Results Reference

Esta página aún no está disponible en tu idioma.

This guide documents what each core script and MCP tool creates, modifies, and returns.

If you want the beginner-friendly command view first, start here:

For the complete MCP overview, tool intent, resources, and prompts, start here:

flowchart LR
A["Command or Tool"] --> B["Creates files"]
A --> C["Updates files"]
A --> D["Returns output"]
A --> E["Affects traceability or gate"]

./scripts/create-www-project.sh <project-name> <assistant> [flags]

Section titled “./scripts/create-www-project.sh <project-name> <assistant> [flags]”

Use when:

  • you want the recommended default workspace inside this template

Creates:

  • ./www/<project-name>/
  • the SDD base structure inside that folder
  • optional Spec Kit setup, if available

Modifies:

  • nothing outside the new workspace folder

Success result:

  • prints the absolute workspace path
  • prints the selected profile
  • prints the next commands to run

./scripts/init-project.sh /absolute/path/to/project --profile=recommended

Section titled “./scripts/init-project.sh /absolute/path/to/project --profile=recommended”

Use when:

  • the user wants the runnable project outside this template

Creates:

  • the full SDD base at the target path
  • idea/, specs/, bitacora/, .sdd/, and helper files

Rules:

  • rejects the template root itself
  • if the target path is inside this template, it must live under ./www/

Success result:

  • prints the initialized path
  • prints the selected profile
  • prints the next commands to continue

./scripts/init-project-with-spec-kit.sh /absolute/path/to/project codex --profile=recommended

Section titled “./scripts/init-project-with-spec-kit.sh /absolute/path/to/project codex --profile=recommended”

Use when:

  • you want the external target path plus GitHub Spec Kit initialization

Creates:

  • everything from init-project.sh
  • Spec Kit configuration for the chosen assistant

Success result:

  • prints the initialized path
  • prints the suggested Spec Kit flow

./scripts/new-spec.sh "feature-name" "Owner"

Section titled “./scripts/new-spec.sh "feature-name" "Owner"”

Creates:

  • specs/NNN-feature-name/
  • spec.md
  • plan.md
  • tasks.md
  • research.md
  • history.md
  • contracts/README.md

Modifies:

  • appends one row to specs/INDEX.md

Success result:

  • prints Created: specs/NNN-feature-name
  • prints Added row to specs/INDEX.md

./scripts/confirm-user-consent.sh "User approved scope X"

Section titled “./scripts/confirm-user-consent.sh "User approved scope X"”

Creates or updates:

  • .sdd/user-consent.log

Success result:

  • prints the log file path used for the appended consent entry

Creates or replaces:

  • STATUS.md

Reads:

  • specs/INDEX.md
  • all tasks.md
  • bitacora/global/PROJECT_LOG.md when present

Success result:

  • prints Generated STATUS.md

Creates or replaces:

  • docs/roadmap.mmd
  • docs/roadmap.md

Reads:

  • specs/INDEX.md

Success result:

  • prints the generated roadmap file paths

Checks:

  • required folders and files
  • template bundle completeness
  • numbered spec directories
  • optional strict history discipline when Git is available

Success result:

  • prints [OK], [WARN], and [FAIL] lines
  • ends with Summary: X error(s), Y warning(s).
  • exits non-zero if any error exists

Checks:

  • sdd.policy.yaml
  • required rule files
  • canonical-source references
  • hard-stop phrasing
  • recommended default workspace phrasing

Success result:

  • prints [OK], [WARN], and [FAIL] lines
  • ends with SDD Policy summary: X error(s), Y warning(s).
  • exits non-zero if any error exists

Checks:

  • approved spec status
  • plan consistency signals
  • tasks presence
  • consent log requirement when approved specs exist

Success result:

  • prints gate status and validation messages
  • exits non-zero if the implementation gate should remain closed

Friendly aliases often used in chat:

  • /start-project -> sdd_create_workspace or guided start prompt
  • /create-spec <name> -> sdd_create_spec
  • /validate-project -> sdd_validate + sdd_check_gate
  • /close-session -> close prompt + validation summary

Scope:

  • managed workspace only
  • creates ./www/<project-name>/ inside this template

Structured output:

  • projectRoot
  • profile
  • assistant
  • usedSpecKit

Scope:

  • any target project path is allowed
  • if the target lives inside this template, it must be under ./www/

Structured output:

  • specId
  • specDir
  • indexUpdated

Structured output:

  • ok
  • errors
  • warnings
  • messages[]

Structured output:

  • ok
  • errors
  • warnings
  • approvedSpecs
  • totalSpecs
  • messages[]

Structured output:

  • logFile
  • summary
  • timestamp

Structured output:

  • specs[]
    • id
    • dir
    • status

Structured output:

  • path
  • content

Side effect:

  • creates or replaces STATUS.md

Structured output:

  • mermaidPath
  • markdownPath
  • mermaid
  • markdown

Side effects:

  • creates or replaces docs/roadmap.mmd
  • creates or replaces docs/roadmap.md

Structured output:

  • path
  • content

Side effect:

  • appends content to bitacora/global/PROJECT_LOG.md

Structured output:

  • path
  • content

Rules:

  • date must use YYYY-MM-DD

Side effect:

  • creates or replaces bitacora/diaria/YYYY-MM-DD.md

Structured output:

  • path
  • content

Rules:

  • fileName must be a simple markdown file name such as 2026-03-18-handoff.md

Side effect:

  • creates or replaces bitacora/handoffs/<fileName>

Structured output:

  • path
  • content

Rules:

  • fileName must be a simple markdown file name such as 2026-03-18-decision.md

Side effect:

  • creates or replaces bitacora/decisiones/<fileName>
  • Use ./www/<project-name>/ as the clean default when the runnable project should live inside this template.
  • Use init-project.sh or init-project-with-spec-kit.sh with an absolute path when the user wants the runnable project elsewhere.
  • Never initialize the runnable project in the template root.