Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.skaro.dev/llms.txt

Use this file to discover all available pages before exploring further.

The .skaro/ directory is the heart of every Skaro project. It contains all artifacts, configuration, and state. Everything here is Markdown or YAML — human-readable and Git-friendly.

​
Directory Layout

.skaro/
├── constitution.md                # Project principles and constraints
├── config.yaml                    # LLM and project settings
├── secrets.yaml                   # API keys (⚠ in .gitignore)
├── state.yaml                     # Phase states, hashes, approval flags
├── token_usage.yaml               # Token consumption tracking (in .gitignore)
├── usage_log.jsonl                # Detailed usage log (in .gitignore)
│
├── architecture/
│   ├── architecture.md            # System architecture document
│   ├── review.md                  # LLM architecture review results
│   ├── invariants.md              # Rules that must always hold
│   ├── diagrams/                  # Mermaid / PlantUML diagrams
│   └── adr-NNN-*.md              # Architecture Decision Records
│
├── devplan/
│   └── devplan.md                 # Project development plan
│
├── milestones/
│   └── <milestone-name>/
│       └── <task-name>/
│           ├── spec.md            # Task specification
│           ├── clarifications.md  # Clarify phase Q&A
│           ├── plan.md            # Implementation plan
│           ├── tasks.md           # Task decomposition
│           └── stages/
│               ├── stage-01/
│               │   └── AI_NOTES.md
│               ├── stage-02/
│               │   └── AI_NOTES.md
│               └── ...
│
├── docs/
│   └── review-log.md             # Cross-validation log
│
├── prompts/                       # Custom prompt overrides (optional)
│   └── *.md                       # Override any built-in phase prompt
│
├── ops/
│   ├── devops-notes.md
│   └── security-review.md
│
└── templates/                     # Artifact templates
    ├── constitution-template.md
    ├── architecture-template.md
    ├── spec-template.md
    ├── plan-template.md
    ├── devplan-template.md
    ├── ai-notes-template.md
    ├── adr-template.md
    └── security-checklist.md

​
File Descriptions

​
Project-Level Files

FilePurposeWho Creates It
constitution.mdImmutable project principlesDeveloper (or LLM during import)
config.yamlProvider, model, roles, UI settingsskaro config or dashboard
secrets.yamlAPI keysskaro config (auto-gitignored)
state.yamlPhase statuses, content hashes, approvalsManaged by Skaro automatically

​
Architecture Directory

FilePurpose
architecture.mdSystem architecture: components, data flows, tech decisions
review.mdResults of LLM architecture review (risks by severity)
invariants.mdArchitectural rules that must never be violated
adr-NNN-*.mdIndividual Architecture Decision Records

​
Task Files (per milestone/task)

FileCreated During
spec.mdTask creation — describes what to build
clarifications.mdClarify phase — LLM questions + developer answers
plan.mdPlan phase — stages with goals, inputs, outputs, DoD
tasks.mdPlan phase — granular task decomposition
stages/stage-NN/AI_NOTES.mdImplement phase — what was done, why, risks, how to verify

​
What to Commit

Add .skaro/ to Git — except files that are auto-gitignored by skaro init:
FileCommit?Why
constitution.md✅Core project artifact
config.yaml✅Shared settings (no secrets)
secrets.yaml❌Contains API keys
token_usage.yaml❌Local tracking data
usage_log.jsonl❌Local tracking data
state.yaml✅Phase progress
Everything else✅Project artifacts
.skaro/prompts/ is optional — commit if prompts are shared across the team, or add to .gitignore if personal. See Custom Prompts for details.

​
Root-Level Files

skaro init also creates two files in the project root (not inside .skaro/):
  • .skaroignore — controls which files are excluded from LLM analysis (gitignore syntax)
  • .gitignore additions — Skaro appends a marked section for secrets and usage logs