Skip to content
DocumentationCLI
On this page

Page resources

Open Markdownllms.txtView source

Last updated

CLI reference

The one command has a fixed lifecycle, supporting project commands, and explicit expert projections of owner stages. Domain operations remain owner-qualified identities; they do not become permanent top-level subcommands.

Core lifecycle

CommandPurpose
one checkValidate the selected project, workspace, provider, adapter, or semantic package without application execution
one testRun root-owned application tests, conformance actions, simulation, or exact replay
one invokeInvoke one exact operation reachable from the selected root
one planProduce an immutable project, release, admission, or publication plan without mutation
one buildMaterialize exact per-root artifacts from locked inputs and an authorized action graph
one applyBegin or resume one exact reviewed plan as a journaled operation
one inspectResolve one owner-qualified subject through its selected owner adapter

The ordinary path is:

Console
one setup
one sync --output one.lock.proposed
one check
one test
one invoke <operation-id> request.json
one plan
one build --root <root-id>
one observe <subject-ref>
one release production build:sha256:<build-digest>
one approve plan:<digest>
one apply plan:<digest>
one inspect operation:<digest>

When scope has exactly one valid root, the interface may infer it. Choices that change meaning, artifacts, authority, placement, cost, target, or assurance remain explicit.

Scope and addressability

Three flags select what a command operates on. The CLI never guesses past an ambiguity; an inferred scope is printed in human output.

FlagSelectsAmbiguity behavior
--workspace <dir>The containing project or workspaceRejected outside every declared project
--project <id>One project inside a workspaceRequired when more than one project matches
--root <id>One root inside a project; may be PROJECT/ROOTRequired when more than one root matches

Reference roles

A reference is <role>:<owner-qualified-identity> for a human, where the identity is namespace#Name@lane for a named record or sha256:<hex> for a content-addressed value. A plan or operation reference is <role>:<digest> for the human CLI, where the digest is sha256:<hex>; the owner-qualified exact reference is one.deployment.local.release#Plan@1:sha256:<hex>. Prose uses plan:<digest> and operation:<digest>; copyable examples use plan:sha256:<hex> and operation:sha256:<hex>. A short alias is admissible only when the selected lock resolves it unambiguously. Machine output always emits the exact owner-qualified reference. plan:, operation:, and other roles never stack a role prefix over a generic identity prefix or a bare revision:/stable: token.

The lifecycle uses one closed role vocabulary for human references. Each command documents which roles it resolves; one inspect and one reconcile resolve the exact subjects described in inspect and operate.

RoleResolves to
planAn immutable reviewed plan
operationA journaled apply or reconcile operation
releaseA deployment release record
artifactA Build artifact
buildA Build report
effectAn external effect relationship
observationAn owner-qualified observation
grantAn authority grant
approvalAn external approval decision
snapshotA retained source or state snapshot
invocationA recorded operation invocation

Machine output always emits the exact owner-qualified reference; a role prefix is a human convenience and is never the identity.

Project and authoring tools

CommandPurpose
one initCreate or adopt an application project through the canonical one.one lifecycle
one sourceAcquire, compare, and safely refresh one exact provider-resolved source snapshot
one packageAdd, remove, update, and inspect explicit root-scoped package selections and lock entries
one syncWrite an exact lock proposal with --output, or accept a complete explicitly reviewed source-and-lock transaction
one updatePropose newer exact selections against an exact registry or catalog observation
one bundleinstall validates and materializes a verified archive; assemble builds a base-free distribution from exact published packages and Build evidence; archive packages a distribution with its executable
one publishPlan or execute a separately authorized package or distribution publication
one setupMaterialize reversible standard local packages, provider inputs, and protected-store bindings
one fmtFormat the .one envelope and known language regions while preserving unknown bodies byte-for-byte
one lspServe source, package, semantic, and source-transaction editor support
one docsMaterialize documentation from exact normalized public contracts
one exportProduce a read-only receipted interoperability, source, client, or distribution projection
one cleanRemove reconstructible local state only
one gcCollect unreachable CAS and cache objects under owner retention rules
one reset localReset durable local state only with explicit dispositions for data, unresolved effects, and protected evidence

Package and editor operations update canonical source and one.lock through revision-checked transactions. They do not create a second manifest, activate code by installation, or turn a dependency into a provider selection.

sync --output and update produce reviewable lock proposals. Accepting a whole-graph proposal uses sync with all three exact --proposed-source, --proposed-lock, and --dependency-comparison inputs. Check, Build, tests, editors, and language servers never mutate the accepted lock implicitly. clean cannot remove durable material, and gc follows reachability from the lock, artifacts, plans, journals, retained evidence, snapshots, and sessions.

Expert owner stages

These commands expose existing owner operations for experts and automation; they are not extra lifecycle stages and cannot bypass a missing predecessor.

CommandOwner operation
one acquireAcquire an exact source or package without accepting its meaning
one analyzeRun exact implementation-language analysis and effect summaries
one inferProduce exact or conservative inference and requirement consequences
one projectMaterialize a deterministic projection with its receipt
one auth admitEvaluate governed or accountable admission for an exact claim
one auth statusShow the selected local owner and current Authority configuration
one auth oidcMaterialize one exact local OIDC JWT trust configuration
one selectSelect providers and topology deterministically without mutation
one observeRead owner-qualified observations
one approveRecord an external approval decision without issuing an implicit grant
one reconcileResume or inspect recovery of one exact unresolved operation
one statusPresent the current owner-qualified operational disposition
one releasesEnumerate releases reachable from the selected project or workspace

one observe takes an exact owner-qualified subject reference (for example a release or observation subject), not an environment or stage name. one plan takes no positional subject; scope, profile, and target are explicit flags.

Interactive and automation interfaces

CommandPurpose
one devRun the framework and API development session selected by one exact application root
one verifyOrchestrate checks, tests, configured Build verification, and policy proof without product mutation
one release <environment> <build-ref>Produce release-intent and apply plans, stopping before apply
one tuiOpen the persistent native workspace for overview, setup, authentication, agents, and inspection
one shellEnter an interactive session over fixed One commands, typed inspection projections, and an explicit human host-program lane
one daemon serve / one daemon statusIllustrative end-product syntax; not a current command. An explicitly selected optional local coordination service
one agentConfigure, run, and resume one bounded headless agent task
one mcpServe the typed automation operations over an admitted MCP transport
one lintRun exact selected source tools and return diagnostics or edit proposals
one debugOpen an exact capability-scoped debug session
one service hostHost one exact completely applied local release
one decommission <subcommand>Construct a governed removal and data-disposition plan

These are projections over public owner operations, not alternate lifecycles. TUI, shell, agent, MCP, CI, and SDK callers cannot bypass source scope, exact locks, root closure, planning, Build authority, approvals, or reconciliation.

The shell's human host-program lane is deliberately separate. Direct argv, byte pipelines, redirection, conditions, bounded jobs, and session-local environment changes remain ordinary host activity. They produce no One semantic, Build, deployment, authority, or History claim and are unavailable to agents and automation as a hidden execution escape.

one release never applies by environment name. It emits exact plan and evidence references. one approve records the approval; apply obtains the applicable fresh grant and begins or resumes the journaled operation. Authentication setup may materialize protected machine-local bindings, while source and plans retain only typed requirements and references.

Exact operations, friendly projections

An operation contract defines inputs, outputs, domain faults, effects, approvals, planning, and reconciliation. The CLI, Rust and peer-language SDKs, HTTP endpoints, UI actions, MCP tools, and agents can project the same contract.

Friendly aliases are accepted only when the exact lock resolves them to one identity. Plans, approvals, receipts, automation, and inspection retain exact owner-qualified identities.

Output and diagnostics

--format human|json applies uniformly. Human output leads with the result and smallest useful next action. Machine output uses stable versioned event streams of owner envelopes and typed diagnostics; consumers never scrape human output.

Diagnostics identify the source span, owner, lifecycle stage, violated contract, minimal conflict, and responsible next action. Delegated compiler, provider, and platform failures remain source-mapped without forcing users to learn their command syntax.

Canonical owner: Developer Interface.

See dependencies and toolchains, One Shell, and the local daemon.