Expand description
Purpose: Provide the ProjectAtlas 3 command-line adapter.
Modulesยง
- atlas_
map ๐ - Purpose: Generate and lint
ProjectAtlasstructure maps from Rust. - derived_
snapshot_ ๐archive - Bounded archive adapter for portable derived graph snapshots.
- mcp ๐
- Purpose: Serve
ProjectAtlasrepository intelligence over MCP. Native MCP adapter forProjectAtlasagent integrations. - runtime ๐
- Purpose: Coordinate shared
ProjectAtlasCLI and MCP runtime workflows. Shared runtime orchestration for theProjectAtlasCLI and MCP adapters. - structural ๐
- Deterministic structural summaries for files without declaration symbols.
- token_
tui ๐ - Purpose: Render token telemetry as package-backed terminal dashboards.
Structsยง
- Claude
McpConfig ๐Document - Claude Code
.mcp.jsoncompatible configuration document. - Claude
McpServer ๐Config - Claude Code MCP server launch entry.
- Cli ๐
- Top-level parsed CLI arguments.
- CliError
Payload ๐ - Stable CLI error details shared by TOON and JSON output.
- CliError
Response ๐ - Structured CLI error payload for typed agent-recoverable failures.
- CliNext
Call ๐ - Existing CLI command that repairs a confirmed stale index.
- Controlled
Input ๐ - Controlled reader used by the installed TOON streaming encoder.
- Controlled
Output ๐ - Bounded output buffer that observes the request control between chunks.
- Coverage
CliFilters ๐ - Borrowed CLI-only coverage filters before typed service parsing.
- Database
Filesystem ๐Error Payload - Content-free database placement details with direct recovery guidance.
- Detailed
Relation ๐Anchor Args - Exact local anchor controls for detailed relation navigation.
- Detailed
Relation ๐Args - Additive options used only by the detailed relation view.
- Detailed
Relation ๐Filter Args - Direction and trust filters for detailed relation navigation.
- Detailed
Relation ๐Limit Args - Traversal and output ceilings for detailed relation navigation.
- McpConfig
Document ๐ .mcp.jsoncompatible server configuration document.- McpServer
Config ๐ - MCP server launch entry.
- Named
Payload ๐ - One dynamic top-level payload field without an intermediate JSON value.
- Open
Code ๐Config Document OpenCodeopencode.jsoncompatible configuration document.- Open
Code ๐McpServer Config OpenCodelocal MCP server launch entry.- Optional
Symbol ๐Selector Args - Optional exact symbol selector shared by the top-level slice command.
- Parity
Check ๐ - One parity check row.
- Parity
Payload ๐ - Agent-facing parity payload wrapper.
- Parity
Report ๐ - Repository-intelligence parity report.
- Purpose
SetPayload ๐ - Stable serialized schema for a CLI purpose update.
- Purpose
SetReport ๐ - Agent-facing payload for a CLI purpose update.
- Relation
Analysis ๐Args - Closed controls accepted only by
symbols relations --view analysis. - Required
Symbol ๐Selector Args - Required exact symbol selector shared by the symbol slice command.
- Root
Report ๐ - Project-local root identity report.
- Runtime
Info ๐Report - Stable runtime identity and capability report for installers.
- Search
Capability ๐Error Payload - Typed optional search-capability failure shared by CLI and MCP adapters.
Enumsยง
- Agent
Error ๐Kind - Stable error kinds shared by CLI and MCP agent payloads.
- CliError ๐
- Error type for CLI boundary failures.
- Command ๐
- Supported
ProjectAtlasCLI commands. - Harness
Config ๐ - MCP host configuration format.
- Health
Command ๐ - Health metadata subcommands.
- Health
Severity ๐Arg - Health severity filter accepted by CLI commands.
- Ignore
Command ๐ - Manual ignore management subcommands.
- Ignore
Kind ๐ - Manual
ProjectAtlasignore entry kind for CLI input. - Output
Format ๐ - CLI output serialization format.
- Parity
Check ๐Status - Stable status values for repository-intelligence parity checks.
- Parity
Command ๐ - Parity gate subcommands.
- Parser
Pack ๐Command - Explicit optional parser-pack lifecycle commands.
- Purpose
Command ๐ - Purpose metadata subcommands.
- Purpose
Lint ๐Level Arg - Purpose curation strictness accepted by
projectatlas lint. - Relation
Analysis ๐Mode Arg - Closed relation analysis selected on the existing symbol-relations route.
- Relation
Confidence ๐Arg - Lowest confidence retained by detailed relation navigation.
- Relation
Direction ๐Arg - Detailed relation traversal direction.
- Relation
Resolution ๐Arg - Resolution state retained by detailed relation navigation.
- Relation
View ๐Arg - Symbol-relation response contract selected by the caller.
- Required
CliCommand ๐ - Required CLI command families whose variants must remain constructible.
- Root
Command ๐ - Project root diagnostics and binding subcommands.
- Root
Transition ๐ - Explicit durable root transition selected by CLI or MCP callers.
- Search
Retrieval ๐Mode Arg - Retrieval family accepted by CLI and MCP search adapters.
- Snapshot
Action ๐ - Portable derived graph snapshot operation.
- Symbols
Command ๐ - Symbol graph subcommands.
- Token
Theme ๐ - Token TUI color theme.
- Token
Trend ๐Window - Token trend grouping window.
- Token
View ๐ - Token report presentation mode.
Constantsยง
- CLI_
INIT_ ๐COMMAND - Existing CLI command that initializes one selected project root.
- CLI_
PAYLOAD_ ๐SYMBOL_ RELATIONS - CLI top-level field for detailed and analysis relation responses.
- CLI_
REFRESH_ ๐COMMAND - Existing CLI command that performs one bounded refresh pass.
- CONTROLLED_
ENCODING_ ๐CHUNK_ BYTES - Maximum bytes copied between cooperative output-control checks.
- DATABASE_
FILESYSTEM_ ๐RECOVERY - Recovery guidance for a database whose local WAL-safe placement was rejected.
- DEFAULT_
CALLER_ ๐LABEL - Default caller-visible compatibility label for token telemetry.
- DEFAULT_
DB_ ๐PATH - Default relative path for the
SQLiteindex. - DEFAULT_
FILE_ ๐SUMMARY_ LIMIT - Default maximum rows returned per structured file-summary section.
- PROJECTATLAS_
MAJOR_ ๐VERSION ProjectAtlasmajor architecture version.- REPOSITORY_
INTELLIGENCE_ ๐PROFILE - Default parity profile for repository-intelligence checks.
- REQUIRED_
CLI_ ๐COMMANDS - CLI command families required for the agent-first repository-intelligence surface.
- WATCH_
MODE_ ๐NOTIFY - Event-backed watcher mode.
- WATCH_
MODE_ ๐ONCE - One-shot watcher refresh mode.
- WATCH_
MODE_ ๐POLLING - Portable fallback watcher mode.
Functionsยง
- bind_
project_ ๐root - Bind, move, or detach a project root without machine-global root state.
- build_
harness_ ๐mcp_ config_ report - Build a harness-specific MCP configuration document for this binary.
- build_
mcp_ ๐config_ report - Build a standards-compliant MCP configuration document for this binary.
- build_
parity_ ๐report - Build the current repository-intelligence parity report.
- build_
root_ ๐report - Build a project-local root identity report.
- build_
root_ ๐report_ with_ transition - Build a root report with optional completed transition details.
- build_
runtime_ ๐info - Build stable runtime identity and capability information.
- build_
token_ ๐calibration - Build an optional local tokenizer calibration over indexed UTF-8 files.
- cli_
command_ ๐name - Return the stable CLI name for a parsed command variant.
- controlled_
named_ ๐output - Serialize one named analysis envelope while retaining deadline and cancellation.
- coverage_
query_ ๐from_ cli - Build one typed bounded coverage query from explicit CLI filters.
- database_
filesystem_ ๐error_ payload - Extract a stable content-free
SQLiteplacement failure from a CLI error. - finalize_
coverage_ ๐output - Stabilize format-specific encoded byte metadata before output and telemetry.
- health_
query_ ๐from_ cli - Build a bounded DB health query from CLI filter arguments.
- load_
cli_ ๐atlas_ config - Load map and lint config with an explicit CLI database override when present.
- load_
purpose_ ๐review_ requests - Load batch purpose review requests from a JSON file.
- load_
token_ ๐atlas_ preview - Load the tiny optional atlas preview through existing indexed relation-family reads.
- load_
token_ ๐atlas_ relations - Load the bounded resolved-relation input owned by the optional atlas preview.
- main ๐
- Parse arguments, execute the command, and convert failures to process exit.
- mcp_
launch_ ๐path - Render a native path for MCP launch config without Windows extended prefixes.
- native_
launch_ ๐path - Return non-Windows paths unchanged.
- open_
index_ ๐for_ current_ read - Open the selected current index through one root-bound read snapshot.
- open_
index_ ๐for_ mutation - Open a selected project database for purpose or health mutation.
- open_
index_ ๐for_ read - Open and verify the durable index before a normal CLI read.
- parse_
cli ๐ - Parse CLI arguments while retaining whether
--dbwas explicitly selected. - print_
output ๐ - Emit either TOON or JSON to stdout.
- print_
tracked_ ๐directory_ output_ estimate - Record estimated-token telemetry for the exact emitted CLI payload.
- print_
tracked_ ๐output_ estimate - Record candidate-set telemetry for the exact emitted CLI payload.
- print_
tracked_ ๐output_ text - Record baseline-text telemetry for the exact emitted CLI payload.
- print_
tracked_ ๐slice_ output - Emit a bounded exact slice and record telemetry for the accepted bytes.
- purpose_
queue_ ๐scope - Return the DB scope for purpose queue CLI switches.
- push_
check ๐ - Append one parity check.
- render_
cli_ ๐error - Render typed source-state failures in the selected agent/script format.
- render_
code_ ๐slice - Render a code slice as compact TOON.
- render_
file_ ๐summary - Render a deterministic file summary as compact TOON.
- render_
mcp_ ๐config_ report - Render MCP configuration as TOON for agents.
- render_
parity_ ๐report - Render repository-intelligence parity as compact TOON.
- render_
root_ ๐report - Render root diagnostics as compact TOON.
- render_
runtime_ ๐info - Render runtime information as compact TOON.
- render_
search_ ๐report - Render a search report as compact TOON.
- render_
settings_ ๐report - Render settings as compact TOON.
- render_
watch_ ๐status - Render watcher status as compact TOON.
- required_
cli_ ๐surface_ present - Return whether the compiled CLI surface contains required command families.
- run ๐
- Execute the selected CLI command.
- run_
parser_ ๐pack_ command - Execute one explicit optional parser-pack lifecycle command from the selected project root.
- serialized_
output ๐ - Serialize output exactly as the CLI will emit it.
- trimmed_
cli_ ๐filter - Return a trimmed non-empty CLI string filter.
- truthy_
env ๐ - Return whether an environment variable is set to a truthy value.
- validate_
required_ ๐runtime_ version - Validate a caller-provided runtime version guard.
- write_
init_ ๐mcp_ config_ files - Write all generated host MCP configs expected after first-run init.
- write_
mcp_ ๐config_ file - Write one generated MCP config document as pretty JSON.
- write_
stderr ๐ - Write text to stderr without using print macros.
- write_
stdout ๐ - Write text to stdout without using print macros.