Skip to content

kaddo explain

Terminal window
kaddo explain # project explanation (human-readable)
kaddo explain --for human # same, explicit
kaddo explain --for agent # compact structured JSON
kaddo explain --scope payments # focused: limit to a domain or keyword
kaddo explain --type adr # focused: limit to one artifact type
kaddo explain --since 2026-01-01 # focused: limit by creation date

Project explanation (no filters)

Run without filters, kaddo explain summarizes the current state of the project from existing Kaddo artifacts:

  • Project metadata (name, state, team, structure)
  • Detected stack (from .kaddo/scan.json)
  • Knowledge status (inventory, context pack, capabilities, architecture baseline, roadmap, agents)
  • Work items and their status
  • Ownership coverage (how many work items declare code: globs)
  • Missing knowledge and suggested next steps

It also writes .kaddo/explain.md and .kaddo/explain.json so the explanation can be reused for onboarding, handoff or by agents. No LLM is called — the output is fully deterministic.

# Project Explanation
## Project
- Name: dotear-web
- State: pre-ai
- Team: indie
- Structure: monorepo
## Detected Stack
- Language: TypeScript
- Framework: Next.js
## Knowledge Status
- Capabilities: missing
- Roadmap: available
- Work items: 2
- Ownership coverage: 1/2 work items
## Suggested Next Steps
1. Use capability-agent to create architecture/capabilities.md.
2. Run `kaddo owners suggest` for Work Items without code ownership.

context vs explain

  • kaddo context prepares input for an LLM agent (external interpretation).
  • kaddo explain summarizes what Kaddo currently knows — for humans, maintainers, onboarding, project review, or agents needing quick state.

Focused mode

With --scope, --type or --since, explain keeps its focused behavior: it explains a subset of artifacts (a domain, an artifact type, or recent changes) instead of the whole project. The --for agent output of focused mode is structured JSON including artifacts, domains, domain_owners, installed_modules, mapped_modules and enabled_plugins.

Mapped modules (multirepo)

When the project has modules registered with kaddo modules map, explain reports them — separately from add-on modules installed with kaddo add:

## Mapped Modules
- storefront-web — frontend — ../frontend — owner: web-team
- orders-api — backend — ../backend — owner: api-team
## Module Artifact Coverage
- storefront-web: module-design, stack, security, standards
- orders-api: module-design, stack

The --for agent output exposes a structured mapped_modules array (with per-module artifacts coverage), distinct from installed_modules.

explain reads mapped modules from .kaddo/modules.yml and the architecture/modules/<id>/ artifacts only. It never scans the secondary repos.