Command and technical reference

Use the guide pages to understand Yoke's concepts and the reference pages for precise commands, fields, and operating rules. Your agent receives relevant guidance through help, command responses, context packets, and installed instructions; you can inspect the same detail when you need it.

Function contracts

Functions and CLI commands

Yoke operations have registered function contracts. The CLI exposes those operations as commands, while the contract defines their inputs, authorization, effects, and results. A command's help is the place to check its supported arguments and recovery steps.

Start with yoke --help, then narrow to a command group and action. Reading help does not perform the action. Routine reads return summaries; use the fields, filters, pages, or full-read option the command offers when you need more detail.

CLI reference · Help and replies · Function families

Contract families

Subject	Detailed reference
Work items	Items
Workflows and transitions	Workflows
Claims	Claims
Worktrees	Worktrees
Generated tasks	Tasks
Project configuration	Project configuration
QA	QA
Runtime	Runtime
Models	Models
Merge-queue attempts	Landing attempts

Inputs and results

Use the public identifiers and shapes the command returns. A refusal describes a condition that prevented the operation, not a successful empty result. Read the reason and supported recovery instead of guessing alternate writes.

Machine-readable output preserves structured results. Human output emphasizes the current question and can link to deeper reads. Neither a local cache nor a rendered document replaces the record that owns the fact.

Agent operation rules

Rules by operation

Operation homes explain how agents carry out classes of work: code changes, shell calls, item updates, claims, verification, delivery, databases, Packs, and architecture changes. The agent should read the relevant home before acting rather than load every procedure at once.

Operation-home index

Shared and project-specific authority

Public operation homes contain reusable product procedures. Project-specific constraints belong in project guidance and Execution instructions. A particular installation's credentials, topology, or release policy should not become a requirement for every user.

The Agent guidance page explains how installed files, skills, packets, and command feedback reach the agent. Detailed rules remain accessible to humans without making the introductory guide repeat them all.

Time and runtime contracts

Timestamp encoding

Time fields need unambiguous encoding so records from different machines can be compared correctly. Runtime contracts define accepted timestamps and conversion rules; user interfaces can display local time without changing the stored instant.

Timestamp encoding

Clock verification

Verification distinguishes an observed timestamp from a guessed one and defines how time-sensitive behavior is checked. This matters for claims, leases, retries, and evidence ordering.

Time verification

Writer ownership

Each runtime fact has an owning writer and contract. Other components should consume that record rather than create competing versions of the same truth. Follow the ownership reference when extending a runtime integration.

Runtime overview · Time ownership · Integration ownership

Documentation contracts

Human summaries and detailed homes

Each guide page explains the subject in plain language and links to the detailed contracts. Details belong with the operation or concept that owns them, so a correction has one maintained home.

Navigation and links

Links should identify the destination clearly and keep detailed reference reachable from the relevant human page. Existing reference links remain useful for agents, advanced readers, and installed guidance.

Published and installed copies

Public documentation is authored in the Yoke repository and distributed through the website and installed documentation bundle. Installed guidance should match the release in use. A source-contributor procedure is not automatically an installed user's requirement.

Teaching standard · Navigation contract · Documentation verification