oxagenDocs
CLI

Knowledge graph from the CLI

Query your governed workspace graph on demand without downloading it into the checkout.

Your Oxagen workspace keeps a governed graph of entities, documents, runs, and stable provider metadata. The CLI queries that shared context through an authenticated, workspace-scoped search. It does not download the workspace graph or quietly inject a bulk copy into an agent run.

These commands call the platform, so you need an authenticated CLI (an Oxagen API key plus an org and workspace).

There is no local replica. The workspace graph stays on the platform, and scoped online capabilities are the only way to read it. There is no bulk graph export, pull cursor, status command, or local copy. oxagen graph search is a bounded query, not a sync.

Search the graph

oxagen graph search sends a natural-language query to the search_graph capability and returns only the results the current organization, workspace, and role allow:

bash
oxagen graph search -q "where do we enforce tenant isolation?"
FlagDescription
-q, --query <text>Natural-language query (required).
-l, --labels <labels>Restrict to entity labels, comma-separated, for example Issue,PullRequest. Each label is the PascalCase type a source gives an entity, such as Issue, PullRequest, or SourceRepository from GitHub.
-n, --limit <n>Maximum results, 1–50 (default 10).
--jsonOne machine JSON line. This is also the default when stdout is piped.
--quietSuppress progress output on stderr.
bash
# Top 5 pull request matches for a rate-limiting question
oxagen graph search -q "rate limiting per org" -l PullRequest -n 5

# Issues and pull requests about the billing service
oxagen graph search -q "billing service outages" -l Issue,PullRequest

Each result carries the entity's label, its name, a snippet, and a similarity score:

Every search is online. The server applies tenant scope and RBAC before it returns a bounded result set, and the CLI does not cache a full workspace graph. A deletion, revocation, or permission change takes effect at the authoritative read, not after a client replica catches up.

What the CLI does not do

The graph search command does not change the workspace graph. Memory commands can write workspace memories. Run records and governed evidence arrive through a separate path from graph writes.

A typical workflow

bash
# 1. Authenticate once (see Account setup)
oxagen login --org acme --workspace eng

# 2. Query shared context explicitly
oxagen graph search -q "how does ingestion dual-write to Postgres and Neo4j?"

# 3. Cite what you found when you brief an agent
oxagen graph search -q "ingestion cursor handling" -l Issue,PullRequest --json

Search is an explicit, bounded read. Running it does not insert results into a later agent turn. An agent that needs the same grounding asks for the same governed capability through the MCP gateway, where the read is metered and audited like any other.

On this page