Documentation

Walkthrough

Not installed? Install Oynix

Local build

The single-user CLI. No Docker, no account. The engine auto-starts when you connect or open the graph, so you rarely type it. The whole flow is: init → connect → open models → mcp setup → ask in your agent.

oynix init

Local setup. Saves an encrypted settings file and asks only where the graph lives (default ~/.oynix/local), then offers to wire your agent. No provider prompt. You start key-free with a structural graph (files, functions, call + import edges) and set the LLM + embedder later in the Models UI. Add a key and re-index (or the connectors page's enrich) to backfill docstrings + embeddings onto the same graph. Nothing is thrown away.

FlagMeaningDefault
--local-path <dir>where the embedded graph lives~/.oynix/local
--forceredo from scratch

Output

✓ Wrote ~/.oynix/config.enc    Oynix is ready. Next: oynix connect

A scripted/CI run can still pass --llm-provider/--llm-key/--llm-model/--llm-url (+ --embeddings-*) to bake a key in non-interactively. Interactive local never asks. That's the Models UI's job.

oynix connect

Starts the engine if needed and prints a URL to the connectors page, then opens it in your browser. Add git repos (they index there, with progress) and doc sources like Jira, Slack, and Google Drive. This is the one surface for adding code and context. Here is the page you open:

Oynix
Connectors
Show

Connect the tools your team already uses. Their tickets, docs and threads become part of the graph and link to the code they're about.

GitHubGitHub Not connected
Google Drive Google Drive Not connected
ConfluenceConfluence Not connected
JiraJira Not connected
Files & DocsFiles & Docs Not connected
This machine Not connected
Select a connector to see its details, sync status and actions.

oynix open [surface]

group

The one launcher for every web surface. Every page shares one top nav, so once any is open you can tab across to the rest. The Models page is where you set your language model and embedder, live with no restart, so you can start key-free and add a provider whenever. Here is that page:

SubcommandWhat it does
openopen the console (lands on connectors)
open modelsthe Models page: set the LLM + embedder key and model
open connectorssame page as oynix connect
open graphsame view as oynix graph
FlagMeaningDefault
--printprint the URL instead of opening a browser
-p / --projecttarget a project
Oynix
Models
Models

Language model

Changeable anytime
What it does

Writes the plain-English summaries (docstrings) for your code, and powers the answers in Ask. It turns raw code into something you can ask questions about.

The better this model, the better every explanation, root cause, and diagram Oynix produces.

Without it: Indexing still builds the structural graph (files, functions, call and import edges), but skips the summaries, so Ask has less to work with.

Status Not set yet
ProviderBring your own key
EndpointAny OpenAI-compatible URL
Start key-free. Add a key here anytime. Live, no restart.

oynix mcp setup

Wire a coding agent to your local engine over MCP. Writes the client's config so your agent answers from your own indexed memory. init already offered to do this; run it any time to add another agent.

FlagMeaningDefault
--client <name|all>which agent to wireclaude
-y / --yesskip confirmation

Output

✓ Registered with Claude Code. Restart it to load the server.
See the full MCP integration guide

oynix graph

group

See the knowledge graph. Running oynix graph opens this view:

SubcommandWhat it does
graphopen the graph view (engine auto-starts)
graph --file [-o graph.html]write a self-contained page that opens offline
graph export [-o file]dump nodes + edges as JSON
graph pathprint the store location
OynixGalaxy

oynix engine

group

The embedded engine lifecycle. It auto-starts when you connect or open the graph, so you rarely type start yourself. Stop and status are the escape hatches.

SubcommandWhat it does
engine startstart the embedded engine (auto-starts; you rarely type it)
engine stopstop the engine
engine restartrestart the engine
engine updatepull the latest engine, keeps your local graph
engine logs [--tail]tail engine logs
engine statusis the engine running?

oynix status

One health summary: the embedded engine, a real store probe, your LLM + embedder providers, and capability coverage.

Output

Oynix Status

engine       ✓ running     (embedded)
store        ✓ ready       (~/.oynix/local)
providers    LLM ✓ qwen-plus    embedder ✓ 1024-d

Capability coverage
  ✓ Code search   ✓ Docs ingest   ○ Vision (add a vision provider)

oynix doctor

Runs checks and prints pass/fail with a fix hint for each failure.

oynix config

group

The encrypted settings file.

SubcommandWhat it does
config set <key> <value>set a value
config get <key>read a value
config listlist all settings
config resetreset to defaults

Common command chains

The recipes that string commands together for everyday goals.

GoalChain
First run (Local)init → connect → mcp setup → (ask in your agent)
Add code / docsconnect (opens the connectors page)
Set a provider keythe Models UI (/models-ui)
Ask about codein your agent over MCP
See the graphgraph (opens the view; --file for offline)
Quality gate (CI)arch check --fail-on-violation
Keep currentengine update (data preserved)
Remove a repoforget <owner/repo> (Master)