Expand description
The distributed CLI for Distributed applications — both a binary and a library.
It bundles pure generation (generate / atlas), the contract lifecycle
surface (contracts), and the clap command surface (cli). The standalone
binary parses DistributedArgs and dispatches with run_distributed.
Host CLIs such as hops may mount ServiceArgs and dispatch with run.
Re-exports§
pub use contracts::check_migration_history;pub use contracts::check_migration_inventory;pub use contracts::check_predecessor_chain;pub use contracts::classify_release_programs;pub use contracts::classify_snapshot_diff;pub use contracts::close_local_contract_chain;pub use contracts::contracts_accept;pub use contracts::contracts_check;pub use contracts::diff_snapshots;pub use contracts::snapshot_from_json;pub use contracts::ArtifactIdentity;pub use contracts::ArtifactPredecessor;pub use contracts::ArtifactProvenance;pub use contracts::BaselineAvailability;pub use contracts::ClassifiedChange;pub use contracts::ClientDeclaration;pub use contracts::ClientInventory;pub use contracts::ClientProgramArtifact;pub use contracts::ClientProgramAsset;pub use contracts::ClientProgramDescriptor;pub use contracts::ClientProgramSurface;pub use contracts::ContractAcceptScope;pub use contracts::ContractArtifactKind;pub use contracts::ContractCatalog;pub use contracts::ContractCheckResult;pub use contracts::ContractDiagnostic;pub use contracts::ContractDiagnosticCode;pub use contracts::ContractEntry;pub use contracts::ContractError;pub use contracts::ContractScope;pub use contracts::ContractsAcceptReport;pub use contracts::ContractsCheckReport;pub use contracts::EnvironmentPolicyReference;pub use contracts::LifecycleDecision;pub use contracts::MigrationDialect;pub use contracts::MigrationEntry;pub use contracts::MigrationFile;pub use contracts::MigrationHistoryCheck;pub use contracts::MigrationInventory;pub use contracts::ObservedPredecessor;pub use contracts::ProgramCompatibility;pub use contracts::SafeDiagnosticValue;pub use contracts::SemanticSnapshot;pub use contracts::SnapshotChange;pub use contracts::SnapshotDiff;pub use contracts::SnapshotEntry;pub use contracts::MAX_CATALOG_BYTES;pub use contracts::MAX_CATALOG_DIRECTORIES;pub use contracts::MAX_CATALOG_DIRECTORY_DEPTH;pub use contracts::MAX_CATALOG_DIRECTORY_ENTRIES;pub use contracts::MAX_CATALOG_ENTRIES;pub use contracts::MAX_CATALOG_FILES;pub use contracts::MAX_CATALOG_GLOB_MATCHES;pub use contracts::MAX_CATALOG_JSON_DEPTH;pub use contracts::MAX_MIGRATIONS;pub use contracts::MAX_MIGRATION_INVENTORY_BYTES;pub use contracts::MAX_MIGRATION_SQL_BYTES;pub use contracts::MAX_SNAPSHOT_DEPTH;pub use contracts::MAX_SNAPSHOT_PATHS;pub use contracts::MAX_SNAPSHOT_VALUE_BYTES;pub use contracts::MIGRATION_INVENTORY_PATH;pub use contracts::MIGRATION_INVENTORY_SCHEMA_VERSION;pub use contracts::MIGRATION_OWNER;pub use contracts::MIGRATION_SCOPE;
Modules§
- contracts
- Generic contract lifecycle records used by the CLI and its future checks.
Structs§
- Atlas
Schema Spec - Input for
render_atlas_schema. Plain data — the caller maps its flags onto this and supplies the desired-state schema SQL. - Client
Args - Client
Compile Error - Stable, source-located error returned for every unsupported or invalid construct. The first compiler slice never silently weakens an operation.
- Client
Compile Input - Complete input to one deterministic client compilation.
- Client
Document - One already-loaded GraphQL source.
- Client
Manifest Args - Client
Route Registration - Explicit
@loadroute fallback, keyed by the GraphQL operation name. - Client
Source Location - Contracts
Accept Args - Contracts
Args - Contracts
Check Args - Describe
Args - Distributed
Args - Top-level standalone CLI arguments for the
distributedbinary. - Embedded
File - One file of an embedded skill, addressed relative to the skill’s folder.
- Embedded
Skill - A skill embedded in the binary at compile time.
- Generated
Client File - Generated
Client Project - Pure compiler output.
filesis sorted by portable relative path. - Generated
File - A single generated file: a relative path and its contents.
- Generated
Operation Summary - Generated
Project - The result of generating a scaffold: the files to write, advisory warnings, and side effects for the caller to perform. Filesystem-agnostic.
- Generated
Route Plan - Github
Repo - An
owner/repoGitHub identifier. - Scaffold
Args - Scaffold
Error - A scaffold generation error (bad spec value).
- Schema
Args - Service
Args - Library adapter for embedding service-related commands under another CLI.
- Service
Scaffold Spec - What to scaffold. The pure input to
generate_service_scaffold. - Skills
Args - Skills
Init Args - Skills
Init Spec - What to generate. The pure input to
generate_skills. All paths in the output are relative to the anchor — the parent of the skills container — which is where.claude/,.agents/, andAGENTS.mdbelong.
Enums§
- Agent
Harness - Which agent harnesses to wire.
codex/grok/openai/gemini/piare aliases foragents— they all discover.agents/skills/— and exist so users can name their tool. - Atlas
Database Url - How the generated
AtlasSchemareaches its target database URL. - Bus
- BusTarget
- Message bus backend to scaffold.
- Client
Route Discovery - Client
Surface Selector - Explicit client authorization surface. This value only verifies manifest provenance; it can never relabel a broader manifest.
- Contracts
Commands - Contracts
Output - Distributed
Commands - File
Mode - File mode hint for a
GeneratedFile. - Framework
- Gitops
Promote - Gitops
Promote Target - GitOps promotion flavor.
- Manifest
Format - Metrics
- Metrics
Target - Metrics integration to scaffold.
- Post
Create Action - A side effect the caller should perform after writing the generated files.
- Schema
Dialect - Schema
Format - Service
Commands - Service
Transport - Runtime transport for the scaffolded service.
- Skills
Commands - Store
- Store
Target - Read-model / schema storage target.
- Transport
Functions§
- compile_
client - Compile one selected manifest and its colocated GraphQL sources.
- embedded_
skills - The registry of skills embedded in this binary.
- generate_
service_ scaffold - Generate a Distributed service project from a spec. The public entry point.
- generate_
skills - Generate every entry
skills initshould write: the canonical<container>/skills/tree, a per-skill symlink (or copy fallback) at each wired harness location, and the mergedAGENTS.md. No I/O — the caller owns writes and per-file drift decisions. - package_
name - Normalize a free-form service name to its kebab-case package/crate directory
name — the same normalization
generate_service_scaffoldapplies. Callers need this to compute a default output directory before generating. - render_
atlas_ schema - Render an
AtlasSchema(db.atlasgo.io/v1alpha1) resource as YAML. - run
- Dispatch a parsed service command. Host CLIs (for example
hops service) call this without mounting the aggregate contracts surface. - run_
distributed - Dispatch the standalone
distributedbinary command tree.