Getting Started

Quick Start

git clone https://github.com/YOUR_USER/JanusLM.git
cd JanusLM

Open the repo in any coding agent — each one picks up its own instruction file automatically:

claude       # reads CLAUDE.md
codex        # reads AGENTS.md
gemini       # reads GEMINI.md

Works with Cursor (.cursorrules) and Cline (.clinerules) too.

On the very first prompt, the agent detects that Python dependencies are missing and installs them automatically — no manual setup needed.

Usage

You can talk to the agent in natural language or use shorthand:

ingest raw/report.md                       # add a document to the wiki
query: what are the main themes?           # ask a question across the KB
lint                                       # spot orphans, broken links, gaps
build graph                                # generate the knowledge graph

Or just say what you need:

"Ingest this paper and tag it as ai-strategy"
"What does the wiki say about RAG across all projects?"
"Are there contradictions in project-alpha?"
"Build the graph and tell me what's most connected"

try it

Ingest raw/report.md and tag it as ai-strategy

In Claude Code, the /maintainer skill wraps these workflows with guided steps.

The Python scripts in tools/ can also run standalone from terminal, without a coding agent.

Commands

Everything you can do with JanusLM — via the agent or standalone from terminal.

Knowledge Base

CommandWhat it does
ingest raw/doc.mdRead a document, extract entities and concepts, create/update wiki pages
query "your question"Search the wiki and synthesize an answer with citations
lintFind orphan pages, broken wikilinks, missing entities, tag mismatches, content gaps
healthStructural integrity checks — empty pages, index sync, log coverage, tag validation
healAuto-fix issues found by health and lint (creates missing pages, repairs links)
statsWiki dashboard — page counts by type, tag distribution, link density
forgetRemove a project, entity, or concept from the wiki (with safety confirmation)

Knowledge Graph

CommandWhat it does
build graphExtract wikilinks, infer implicit relationships, generate interactive graph.html

File Conversion & Maintenance

CommandWhat it does
/convertConvert any non-markdown file to markdown for ingest
/privacy-modeEnable or disable local PII anonymization (Claude Code only)
/scaffoldCheck project structure and recreate any missing directories or scaffold files
/setupInstall or reinstall Python dependencies

All scripts accept --help for full options. Most also support --json for machine-readable output and --save to write results to the wiki.