CLI reference
InterfacesThe CLI is the command-line tool you and your agent use to run Lyt. Lyt ships one CLI for local-first vaults, meshes, pod operations, search, and agent integration. Use its built-in help as the authority for flags on your installed version.
Start with the installed binary: lyt --version reports its release, lyt help lists the assembled command tree, and lyt <command> --help explains a command and its nested verbs. New to the model? Read the concepts first.
lyt helpKnowledge
Create and retrieve local knowledge, inspect its contract, and rebuild derived indexes.
- lyt search <query>
- Search the pod's local indexes. Use --vault or --mesh to narrow scope, and --no-semantic for lexical-only results.
- lyt capture <text> --purpose <p> --topic <t>
- Write one Figment through the frontmatter contract. --purpose and --topic are author-supplied and required; an interactive run prompts for them, a non-interactive one refuses without them. --vault is required unless the pod holds exactly one vault.
- lyt primer --scope <scope>
- Generate a local context digest for a vault, mesh, or federation scope.
- lyt contract [--json]
- Read the versioned source of truth for Figment frontmatter and its defaults.
- lyt reindex --vault <name>
- Rebuild derived local indexes for exactly one selected scope: --vault, --mesh, or --all.
- lyt undo
- Reverse the last supported vault-writing operation after validating its recorded local operation.
Vault lifecycle
Create, adopt, inspect, move, and recover the markdown vaults in your pod.
- lyt vault init <mesh>/<vault>
- Create a new vault and place it in a mesh; destination intent is explicit and initialization does not itself publish.
- lyt vault adopt <path>
- Add an existing Obsidian or markdown vault to Lyt without rewriting its markdown.
- lyt vault clone <url>
- Clone and register a Lyt vault, optionally assigning it to a mesh.
- lyt vault list | info | refresh
- List local registrations, inspect one vault, or refresh its cached remote/publishability verdict.
- lyt vault move | rename
- Change a vault's home mesh or leaf name while its rid remains stable.
- lyt vault snapshot | restore
- Create a local recovery snapshot or restore a named snapshot.
- lyt vault reconcile <name> [--apply]
- Detect frontmatter or index drift; --apply backfills missing contract data and reindexes.
- lyt alias <name> <target>
- Create a pod-local @alias for a vault's stable identity.
Meshes
A mesh declares related vaults and their topology; it is separate from access permission.
- lyt mesh init <name>
- Create a mesh and its main vault, with an explicit local or GitHub destination policy.
- lyt mesh list | info
- List registered meshes or inspect one mesh's local topology and policy.
- lyt mesh add-edge
- Declare a relationship between vaults; use mesh rebuild-rollup to refresh its derived projection.
- lyt mesh validate
- Validate a mesh's declared topology and report broken relationships.
- lyt mesh subscribe
- Add a public vault as a local subscription in a mesh.
- lyt mesh prune <name> --yes
- Remove an empty or orphan mesh registry record; it refuses meshes that still contain vaults.
Pod setup & operations
Your pod is the local operating view of its vaults, meshes, and subscriptions.
- lyt init
- Run the Handler-driven bootstrap wizard. Agents use lyt init --auto --json for the non-interactive path.
- lyt discover
- Discover eligible Lyt repositories and offer a controlled route into local registration.
- lyt status
- Report pod-level publish and local-state drift without changing it.
- lyt sync [--vault <name>]
- Synchronize the selected vault through Lyt's managed sync path; use --check for read-only freshness inspection.
- lyt repair [--dry-run | --apply]
- Diagnose and repair pod registration or topology drift through the supported recovery path.
Maintenance & updates
Check the environment, control local semantic search, and keep the installed toolchain current.
- lyt doctor
- Diagnose the installed CLI, local registry, and available recovery actions.
- lyt model fetch
- Download and set up the local embedding model that meaning-based matching uses. Matching is on by default and falls back to keywords until the model is present; no search triggers this fetch.
- lyt model nudge
- Inspect or record the user's explicit semantic-search offer decision.
- lyt outdated
- Check the configured npm release channel for a newer Lyt version without changing the installation.
- lyt update
- Update Lyt after confirmation; non-interactive calls require their explicit confirmation flags.
- lyt install reconcile [--apply]
- Inspect managed Lyt skills and manuals; apply only the inspected reconciliation plan when requested.
Agent interfaces
Install the agent-facing protocols and expose the same local operations to an MCP client.
- lyt skills install
- Install Lyt's focused skills into a supported agent runtime.
- lyt agent-manual --install
- Install or refresh Lyt's managed agent-manual block for a selected runtime.
- lyt mcp
- Inspect the MCP server command that exposes typed Lyt operations to compatible clients.
- lyt help <topic>
- Open focused help for commands, agents, sync, meshes, troubleshooting, and other supported topics.
Reviewed