docs/generated/vocabulary.mdgenerated from code

Reference · 10 min read

op

Vocabulary: op.

Local API operations (discussion:owner/272): the JSON-RPC method names. The CLI spells checkpoint, approve, and revoke as lvcs checkpoint, lvcs approve, and agentflare revoke, and status as agentflare status, which also works with no daemon; other CLI commands (init, join, key, daemon, rpc, replay, audit, genesis, explain, hook, sandbox) are not operations. Also the op telemetry attribute.

ValueMeaning
helloName the peer this connection acts for; required first on every connection (discussion:owner/272).
openLoad a document and return its address and kind.
readReturn a document's rendered body, or the value at a pointer into its Loro structure.
editApply splices given against the caller's base heads (discussion:owner/434).
moveRename a file, keeping its history and blame (discussion:owner/434). CLI: lvcs mv.
removeDelete a file against the heads it was read at, as an edit of it is checked (discussion:owner/434). CLI: lvcs rm.
subscribeReceive pushed changes for an address or subtree.
snapshotReturn main's visible frontier: its id and the map from document to heads.
grantIssue a capability grant signed by the calling peer: the owner, or a holder of a delegable grant (discussion:owner/146); the issuer's daemon renews one with a window, unattended, as a new grant with the same terms (discussion:owner/148).
revokeRevoke a grant and every unrevoked grant of its lineage, its renewals: a signed caps record each, after which no change at or past its time is within the grant (discussion:owner/148).
file.purgePurge deleted files' documents from the project, owner only: a signed, final caps record after which every honest node drops their content and never serves, syncs, or accepts it again (discussion:owner/614). CLI: agentflare purge.
sync.deliverTest builds only (e2e-forge, release-qual/16): take a sync payload for a document as if the named connected node had sent it on its sync stream, down the receiver's whole path (its held flag and intake, the node's share of the byte budget, the document's checks). The daemon's own user only, over its socket; any other build refuses it not_supported.
addSave a file of the tree as it is on disk, sending its refused save through intake again; with force, a secret_detected false positive is saved, each flagged string recorded in a signed allowlist entry with the reason given (discussion:owner/513). CLI: agentflare add.
stop_gateWhether the caller may stop now (discussion:owner/214 and discussion:owner/217), as the Stop hook asks: failed while an action_failed streak of its is open, pending while the change set holds no frontier with its newest change to each file, and passed otherwise.
saves.latestThe caller's newest saves, each changed file with its newest heads, as the stop gate keeps them (discussion:owner/532): a plugin judges which of its frontiers holds them.
notificationsList the caller's notifications, metadata only (who sent each, its kind, where, when, and its size, never what it says): its unread notifications, stale and refused saves and failed checks first, then write notifications, each newest first. Listing marks nothing read (discussion:owner/118 and discussion:owner/176).
notifications.readRead the content of the caller's notifications named by ids, and mark them read; an id it doesn't hold is listed as missing (discussion:owner/173 and discussion:owner/176).
notifications.waitWait until a new notification of an attention kind (action_failed, refused_write, or the kinds named) arrives for the caller, then answer its metadata, never its text; with none by timeout_ms, answer no notification (discussion:owner/424).
statusWhere the caller stands, read-only: its tier, trees, live grants and whether each renews, grants ended lately, how many notifications wait unread, stale saves, the connected node count, and the last error the daemon answered it (discussion:owner/164). It shows the caller only its own.
approveApprove the named protected paths at a frontier every change channel attests: an approval in .lvcs/approvals by any holder of Approve (discussion:owner/123, discussion:owner/147, and discussion:owner/297).
channel.readReturn a channel's value: its counted frontiers, each with its attestation and approval counts (discussion:owner/120).
runRun a gated action by hand (its manual trigger): a run request in its channel by a holder of Approve on it, whose run the channel's runners carry out, on the named frontier or, when none is named, the one its after channel holds; a rollback is a run on an earlier frontier the channel held. CLI: lvcs run <action> [<frontier-id>] (discussion:owner/141 and discussion:owner/204, the triggers row).
initCreate a project at a root and host it (discussion:owner/272): the owner key, the project id, the capability file, and one document per file; a request to the per-user daemon on a connection whose hello names no root.
joinJoin an existing project from its nodes into a root and host it (discussion:owner/107 and discussion:owner/272); a request on a connection whose hello names no root.
forgetStop hosting a project and drop it from the registry, leaving its files alone (discussion:owner/272); a request on a connection whose hello names no root.
projectRegister an initialized project with the daemon, or change how it is hosted: its default peer and its transport, then open it again (discussion:owner/272); a request on a connection whose hello names no root.
key.newCreate a peer key in the connection's project and return its peer id (discussion:owner/272).
key.encryptionThe connection's peer's X25519 encryption public key, which the keyring derives from that peer's signing key (discussion:owner/531, discussion:owner/514).
key.openOpen an HPKE wrap sealed to the connection's peer's encryption key, inside the keyring; local socket only (discussion:owner/531, discussion:owner/514).
key.endorseThe connection's peer's Ed25519 signature over a plugin's domain-separated message, so a plugin can publish what that peer itself vouches for; local socket only (discussion:owner/514).
key.heldThe peers whose signing keys this daemon holds for the project (discussion:owner/568); local socket only.
key.handedThe calling plugin is ready for a replaced key to go (discussion:owner/768, o-edge/8); local socket only.
key.handover_blockedThe calling plugin can't be ready for a replaced key to go on this node, why, and the next step (discussion:owner/768, o-edge/8); local socket only.
grant.holdersThe peers whose live grants hold a capability on an address, and the owner (discussion:owner/514).
channel.listList every action's channel and every [channels] combination of main's approved lvcs.toml: its trigger kind and its value's frontiers with their counts (discussion:owner/303).
run.listList the runs runners gossiped, newest first, optionally of one channel or one frontier (discussion:owner/303).
checks.listList every check on a peer's latest changes, one per action, as gh pr checks lists a PR's (discussion:owner/427).
node.listList the connected nodes: whether each is direct or relayed and the peers known to sign from it (discussion:owner/303).
node.loadOne connected node's recent load in this project: its daemon's latest resource samples and memory by part, asked of that node over the project's swarm (discussion:owner/400).
presence.listList the live presences: who is on which document ( discussion:owner/303).
watchSubscribe the connection to platform pushes: channel_moved, run, presence, activity (discussion:owner/303).
project.summaryOne summary per hosted project, read as its default peer: owner, peers present, channels, recent activity; on the host's connection (discussion:owner/303).
inboxEvery hosted project's notifications for its default peer, metadata only; on the host's connection ( discussion:owner/303).
blameWho wrote each line of a file at given heads, from the document's history (discussion:owner/303).
change.signersThe peer that signed each change id asked, from the documents' verified signatures; an id this node doesn't hold is left out (discussion:owner/685).
main.versionsMain's newest saved versions, newest first: each one's frontier, time, signer, and the files it changed (discussion:owner/687).
channel.historyThe moves of a channel's value this daemon saw, newest first (discussion:owner/303).
file.historyA file's saves, newest first: each change to its text, who made it, when, and the lines it touched (discussion:owner/399).
searchThe lines of main's text files holding a query, ignoring case, read from the main tree (discussion:owner/303).
resourcesThe per-user daemon's own use over the last hour: CPU, memory, sandbox slots, and each project's storage; on the host's connection (discussion:owner/303).
event.publishPublish a signed event (discussion:owner/515): a durable one appended to its plugin ledger at .lvcs/x/<plugin>/..., admitted under write on it and the plugin's manifest rules; an ephemeral one by gossip.
event.readRead a plugin ledger's events, oldest first, of the kinds asked, the last limit when given (discussion:owner/515).
event.listThe ledgers this daemon holds under a prefix, each with its heads (discussion:owner/515).
event.subscribeDeliver each event under a prefix, of the kinds asked, as event pushes (discussion:owner/515).
event.unsubscribeEnd an event.subscribe of the caller's connection ( discussion:owner/520).
peer.resolvePeers' ids from the names people type: an alias, an id, or an id's start, and the caller's own id (discussion:owner/514).
plugin.installInstall a plugin from its manifest: its key, exactly the grants it declares, and its record in .lvcs/caps (discussion:owner/514). CLI: agentflare plugin install.
plugin.listThe installed plugins, their commands and directories ( discussion:owner/514). CLI: agentflare plugin list.
plugin.surfacesThe installed plugins and the UI surfaces they ship, for the app (discussion:owner/520).
plugin.assetOne file a plugin's surfaces declare under its ui/ (discussion:owner/520).
plugin.configurePropose a plugin's settings from a device with write: its [plugins.<name>], a protected change (discussion:owner/521).
plugin.configA plugin's settings: their approved values, its manifest's defaults, and a change waiting for approval (discussion:owner/521).
plugin.upgradeReplace an installed plugin's manifest, grants, and record with a newer one's (discussion:owner/514). CLI: agentflare plugin upgrade.
plugin.removeRemove an installed plugin: revoke its grants and delete its record (discussion:owner/514). CLI: agentflare plugin remove.
plugin.enableEnable a plugin the node's store holds in this project: its key and exactly the grants its manifest declares (discussion:owner/768). CLI: agentflare plugin enable.
plugin.disableDisable a plugin in this project: revoke its grants and stop it, keeping its key and documents (discussion:owner/768). CLI: agentflare plugin disable.
plugin.dormantA plugin's serve, from its own process, ends itself idle: its keeper keeps it down until one of its wake filters matches an event, its wake time comes, or an install or upgrade starts it (discussion:owner/790). Not a CLI command.
plugin.busyA plugin's serve, from its own process, answers a plugin.rest push that it is busy and stays up (discussion:owner/790 item 3). Not a CLI command.
plugin.admitRoom in the plugins' memory share for one plugin command, asked before the CLI runs it (discussion:owner/790 item 3); answered once there is room, or refused recover=wait. Not a CLI command.
run.viewOne channel's runs on one frontier: each runner's state, the action's steps, and this daemon's run's log tail ( discussion:owner/312).
files.listMain's files with presence counts (discussion:owner/312).
frontier.readA frontier's file documents and their heads: main's visible frontier, or one a channel holds, by id (discussion:owner/518).
writeSave a whole file, text or bytes, from a base (discussion:owner/518).
tree.materializeWrite a frontier's files matching some patterns into a directory under .lvcs/tmp/, local only (discussion:owner/518).
doc.descendsWhether a document's heads descend from others, local only (discussion:owner/518).
protected.readEach protected path's approved heads and baseline, local only (discussion:owner/518: the actions plugin's saved-approval rule).
auth.loginStart pairing a device (discussion:owner/300): a one-time link for the app and the scope the device will get.
auth.waitWait for a device to claim a pairing; answered with its key and the code it shows (discussion:owner/300).
auth.confirmAccept or decline the device that claimed a pairing; accepting grants it its scope (discussion:owner/300).
auth.pairA device claims a pairing from its link (discussion:owner/300); answered once the pairing is confirmed or declined.
auth.statusThe peer's paired devices (discussion:owner/300).
auth.logoutRevoke a paired device by its alias (discussion:owner/300).
host.enableTurn the host node on and keep it on (discussion:owner/300); a request on a connection whose hello names no root.
host.disableTurn the host node off and keep it off (discussion:owner/300); a request on a connection whose hello names no root.
auth.signA write device's signature over what the daemon's push sign asked it to sign (discussion:owner/300).

Cardinality: 85.