Crate projectatlas

Crate projectatlas 

Source
Expand description

Purpose: Provide the ProjectAtlas 3 command-line adapter.

Modulesยง

atlas_map ๐Ÿ”’
Purpose: Generate and lint ProjectAtlas structure maps from Rust.
derived_snapshot_archive ๐Ÿ”’
Bounded archive adapter for portable derived graph snapshots.
mcp ๐Ÿ”’
Purpose: Serve ProjectAtlas repository intelligence over MCP. Native MCP adapter for ProjectAtlas agent integrations.
runtime ๐Ÿ”’
Purpose: Coordinate shared ProjectAtlas CLI and MCP runtime workflows. Shared runtime orchestration for the ProjectAtlas CLI and MCP adapters.
structural ๐Ÿ”’
Deterministic structural summaries for files without declaration symbols.
token_tui ๐Ÿ”’
Purpose: Render token telemetry as package-backed terminal dashboards.

Structsยง

ClaudeMcpConfigDocument ๐Ÿ”’
Claude Code .mcp.json compatible configuration document.
ClaudeMcpServerConfig ๐Ÿ”’
Claude Code MCP server launch entry.
Cli ๐Ÿ”’
Top-level parsed CLI arguments.
CliErrorPayload ๐Ÿ”’
Stable CLI error details shared by TOON and JSON output.
CliErrorResponse ๐Ÿ”’
Structured CLI error payload for typed agent-recoverable failures.
CliNextCall ๐Ÿ”’
Existing CLI command that repairs a confirmed stale index.
ControlledInput ๐Ÿ”’
Controlled reader used by the installed TOON streaming encoder.
ControlledOutput ๐Ÿ”’
Bounded output buffer that observes the request control between chunks.
CoverageCliFilters ๐Ÿ”’
Borrowed CLI-only coverage filters before typed service parsing.
DatabaseFilesystemErrorPayload ๐Ÿ”’
Content-free database placement details with direct recovery guidance.
DetailedRelationAnchorArgs ๐Ÿ”’
Exact local anchor controls for detailed relation navigation.
DetailedRelationArgs ๐Ÿ”’
Additive options used only by the detailed relation view.
DetailedRelationFilterArgs ๐Ÿ”’
Direction and trust filters for detailed relation navigation.
DetailedRelationLimitArgs ๐Ÿ”’
Traversal and output ceilings for detailed relation navigation.
McpConfigDocument ๐Ÿ”’
.mcp.json compatible server configuration document.
McpServerConfig ๐Ÿ”’
MCP server launch entry.
NamedPayload ๐Ÿ”’
One dynamic top-level payload field without an intermediate JSON value.
OpenCodeConfigDocument ๐Ÿ”’
OpenCode opencode.json compatible configuration document.
OpenCodeMcpServerConfig ๐Ÿ”’
OpenCode local MCP server launch entry.
OptionalSymbolSelectorArgs ๐Ÿ”’
Optional exact symbol selector shared by the top-level slice command.
ParityCheck ๐Ÿ”’
One parity check row.
ParityPayload ๐Ÿ”’
Agent-facing parity payload wrapper.
ParityReport ๐Ÿ”’
Repository-intelligence parity report.
PurposeSetPayload ๐Ÿ”’
Stable serialized schema for a CLI purpose update.
PurposeSetReport ๐Ÿ”’
Agent-facing payload for a CLI purpose update.
RelationAnalysisArgs ๐Ÿ”’
Closed controls accepted only by symbols relations --view analysis.
RequiredSymbolSelectorArgs ๐Ÿ”’
Required exact symbol selector shared by the symbol slice command.
RootReport ๐Ÿ”’
Project-local root identity report.
RuntimeInfoReport ๐Ÿ”’
Stable runtime identity and capability report for installers.
SearchCapabilityErrorPayload ๐Ÿ”’
Typed optional search-capability failure shared by CLI and MCP adapters.

Enumsยง

AgentErrorKind ๐Ÿ”’
Stable error kinds shared by CLI and MCP agent payloads.
CliError ๐Ÿ”’
Error type for CLI boundary failures.
Command ๐Ÿ”’
Supported ProjectAtlas CLI commands.
HarnessConfig ๐Ÿ”’
MCP host configuration format.
HealthCommand ๐Ÿ”’
Health metadata subcommands.
HealthSeverityArg ๐Ÿ”’
Health severity filter accepted by CLI commands.
IgnoreCommand ๐Ÿ”’
Manual ignore management subcommands.
IgnoreKind ๐Ÿ”’
Manual ProjectAtlas ignore entry kind for CLI input.
OutputFormat ๐Ÿ”’
CLI output serialization format.
ParityCheckStatus ๐Ÿ”’
Stable status values for repository-intelligence parity checks.
ParityCommand ๐Ÿ”’
Parity gate subcommands.
ParserPackCommand ๐Ÿ”’
Explicit optional parser-pack lifecycle commands.
PurposeCommand ๐Ÿ”’
Purpose metadata subcommands.
PurposeLintLevelArg ๐Ÿ”’
Purpose curation strictness accepted by projectatlas lint.
RelationAnalysisModeArg ๐Ÿ”’
Closed relation analysis selected on the existing symbol-relations route.
RelationConfidenceArg ๐Ÿ”’
Lowest confidence retained by detailed relation navigation.
RelationDirectionArg ๐Ÿ”’
Detailed relation traversal direction.
RelationResolutionArg ๐Ÿ”’
Resolution state retained by detailed relation navigation.
RelationViewArg ๐Ÿ”’
Symbol-relation response contract selected by the caller.
RequiredCliCommand ๐Ÿ”’
Required CLI command families whose variants must remain constructible.
RootCommand ๐Ÿ”’
Project root diagnostics and binding subcommands.
RootTransition ๐Ÿ”’
Explicit durable root transition selected by CLI or MCP callers.
SearchRetrievalModeArg ๐Ÿ”’
Retrieval family accepted by CLI and MCP search adapters.
SnapshotAction ๐Ÿ”’
Portable derived graph snapshot operation.
SymbolsCommand ๐Ÿ”’
Symbol graph subcommands.
TokenTheme ๐Ÿ”’
Token TUI color theme.
TokenTrendWindow ๐Ÿ”’
Token trend grouping window.
TokenView ๐Ÿ”’
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 SQLite index.
DEFAULT_FILE_SUMMARY_LIMIT ๐Ÿ”’
Default maximum rows returned per structured file-summary section.
PROJECTATLAS_MAJOR_VERSION ๐Ÿ”’
ProjectAtlas major 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 SQLite placement 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 --db was 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.