Skip to content

contox explain

Deep-dive into any brain schema key. This command shows detailed information about a specific part of your project brain, including metadata, content preview, links to related contexts, and recent entries.

Usage

bash
contox explain <schemaKey> [options]

Arguments

ArgumentDescriptionRequired
schemaKeyThe schema key to inspect (e.g., root/contracts/auth)Yes

Options

FlagDescriptionRequiredDefault
--jsonOutput in JSON formatNofalse

Examples

Explain a specific schema key:

bash
contox explain root/architecture

Inspect an implementation context:

bash
contox explain root/implementation/auth

Get JSON output:

bash
contox explain root/bugs --json

What it shows

The explain output includes:

SectionDescription
MetadataSchema key, tier, context type, write policy, state
Content previewA preview of the context's content
LinksIncoming and outgoing links to other contexts (depends-on, see-also, related, child-of)
Recent entriesThe most recent journal entries for this context

Schema key format

Schema keys follow a hierarchical path format:

  • root -- The top-level brain node
  • root/architecture -- Architecture context
  • root/conventions -- Conventions context
  • root/implementation -- Implementation journal
  • root/decisions -- Decisions context
  • root/bugs -- Bugs and fixes
  • root/todo -- Pending tasks

Notes

  • This command is useful for understanding how a specific piece of knowledge fits into the broader brain structure.
  • Links show relationships between contexts, helping you trace dependencies and related information.
  • Use this alongside contox status to audit your project brain.