status

What It Does

status prints the current repository state that matters to RAGit: branch, HEAD, backend, manifest count, knowledge readiness, event-ledger activity, the split between the configured embedding profile and the persisted store contract, the active embedding-cache namespace summary, and the current security posture summary.

When To Use / When Not To Use

When to use it

You want a quick operational snapshot of the current repository.
You want to confirm whether the store is loaded and whether retrieval should be ready.
You want to inspect config surfaces without opening files manually.

When not to use it

You want a deeper health diagnosis. Use doctor.
You want to change config values. Use config set.

Syntax

pnpm ragit status [--format text|json|both] [--cwd <path>]

Arguments And Options

--format text|json|both: Choose human text, JSON, or both.
--cwd <path>: Run against another repository.

Input And Output Contract

There is no positional input and no JSON payload input.
JSON output includes branch, head, backend, zvec, supported_types, docsAuthority, knowledge, events, manifests, embedding.configured, embedding.store, embedding.cache, embedding.ready, embedding.needsMigration, security, and format.
embedding.cache reports enabled, dir, namespaceId, entryCount, batchPolicy, retryPolicy, writable, and namespaceReadable.
security reports maskingConfigured, remoteEmbeddingPolicy, providerEgressClass, outputRemasking, quarantineEntries, lastAuditAt, and legacyUnsafeState.
Agents should usually call --format json.

Examples

Human terminal flow:

pnpm ragit status

Agent-oriented flow:

pnpm ragit status --format json

Failures And Cautions

status is a summary, not a repair command.
A loaded store does not guarantee that your latest docs are indexed. Run ingest after content changes.
Event counters reflect append-only operational ledger activity, not snapshot semantic deltas. Use timeline when you need the detailed time axis.
When embedding.needsMigration=true, change the store with migrate embeddings before running write paths against the new provider contract.
When embedding.cache.enabled=false while cache is expected, inspect doctor for embedding.cache-dir and embedding.cache-namespace.

status

On this page