Knowledge compiler — turns scattered links, files, and bookmarks into a living wiki that compounds with every new source.

Most tools save your stuff and forget about it. Kompl reads it, extracts the knowledge, and compiles it into an interlinked wiki, automatically.

• One new source can update 10+ wiki pages. Cross-references, contradictions, and synthesis are built at ingest time, not re-discovered on every query.
• Entity pages, concept pages, comparisons, and source summaries are wikilinked together. The wiki gets richer with every source you add.
• Runs locally via Docker. Outbound calls are limited to your own API keys (Gemini and/or DeepSeek for compilation, Firecrawl for scraping) and the URLs you choose to ingest.

Built with Next.js, Python NLP, n8n orchestration, and SQLite.

You'll need three things on your machine:

• Docker — Docker Desktop (Windows/Mac) or Docker Engine + Compose plugin (Linux). Compose v2 is required (docker compose, not docker-compose). Make sure Docker is running before setup.
• Node.js ≥ 24 — to install and run the kompl CLI.
• ~5 GB free disk and 4 GB free RAM — Kompl runs three containers (app, NLP service, n8n) plus pulls a ~90 MB embedding model on first compile.

You'll also need API keys. Two are required, two are optional:

macOS / Linux / WSL / Git Bash:

curl -fsSL https://raw.githubusercontent.com/tuirk/Kompl/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/tuirk/Kompl/main/install.ps1 | iex

The installer pre-flights Docker, Node 24, disk, and RAM, clones the repo, and hands off to setup.js for the API-key prompts. If anything's missing it fails fast with a copy-paste fix.

Prefer to inspect the script before running it? Download with curl -fsSLO (or iwr -OutFile on PowerShell), open it in your editor, then run with bash install.sh (or .\install.ps1).

git clone https://github.com/tuirk/Kompl.git kompl
cd kompl
node setup.js

Either path: the script handles everything — creates your config, asks for the two required API keys (and offers prompts for the two optional ones), installs the kompl CLI, and starts the stack. No other steps needed. Your system timezone is detected and written to .env as KOMPL_TIMEZONE automatically.

Your API keys land in .env at the repo root. That file is gitignored — never commit it.

First start takes 5–10 minutes — Docker is building images (~2 GB on first start) and downloading the local AI model from HuggingFace. Make a coffee. Subsequent starts take ~15 seconds.

Check when it's ready:

kompl status

Then open in your browser:

kompl open

Or visit http://localhost:3000 directly.

The onboarding wizard will walk you through your first sources — paste a URL, drop a PDF, or import a Twitter bookmark export.

If something looks stuck:

kompl logs       # stream service logs
kompl status     # health check

Common first-run issues: Docker isn't running, port 3000 is occupied, or the first-time image build is still pulling (~2 GB).

kompl start      # start Kompl
kompl stop       # stop it
kompl restart    # stop + start in one command
kompl open       # open in browser
kompl status     # health check: page count, NLP service, vector backlog
kompl logs       # stream logs if something looks wrong
kompl update     # pull latest source, rebuild images, and restart (~5–10 min)
kompl backup     # download a full backup to ~/.kompl/backups/kompl-backup.kompl.zip
kompl init       # re-run the first-time setup wizard (rarely needed)

Pulled latest main but don't see new UI (health checks, bookmark filters, etc.)? Your Docker images are probably stale — git pull updates files on disk, but the running app and nlp-service containers are built from source at install time. Only the n8n image updates via docker compose pull.

Your wiki is safe on a normal update. Page data lives on the Docker volume kompl-data. kompl update and docker compose up --build -d rebuild containers but do not wipe that volume. Back up anyway before major upgrades:

kompl backup     # ~/.kompl/backups/kompl-backup.kompl.zip
kompl update

⚠ Never run docker compose down -v unless you intend to delete everything. The -v flag removes volumes. bash scripts/integration-test.sh is also destructive — see Backup and restore.

Recommended:

kompl update

This pulls source, refreshes the kompl CLI, pulls registry images, rebuilds app + nlp-service, and waits for /api/health (~5–10 min).

Manual fallback (same steps; use if your kompl binary predates this fix):

cd <projectDir>    # path in ~/.kompl/config.json
git pull --ff-only
cd cli && npm install && npm run build && npm link
docker compose pull
docker compose up --build -d

kompl start and kompl restart restart existing images in ~15 seconds — they do not rebuild after a pull.

Verify: onboarding should route through /onboarding/health; importing browser bookmarks should skip x.com / twitter.com URLs with a toast.

Kompl ships an MCP server so any MCP-capable agent built on @modelcontextprotocol/sdk can query your compiled wiki. Ask "what does my wiki say about X?" and the agent gets pre-synthesized pages with provenance back to the originals, not raw chunks.

⚠ Single-tenant. Kompl assumes you own the host. There's no multi-user auth — don't expose your instance to the public internet without putting your own auth in front.

cd mcp-server && npm install && npm run build

Configure your MCP client to run node mcp-server/dist/index.js with KOMPL_URL=http://localhost:3000. Kompl must be running (kompl start) for the MCP tools to respond.

The server exposes four: search_wiki, read_page, list_pages, wiki_stats.

If you're not using MCP, hit the Next.js routes directly: /api/pages/search, /api/wiki/{page_id}/data, /api/wiki/index.

Your wiki content lives in Docker volumes on your machine. Outbound network calls fall into three buckets:

You drive these — your content goes to a third party:

• Gemini (generativelanguage.googleapis.com) — wiki compilation when the Gemini backend is selected. Your source text is sent to Google.
• DeepSeek (api.deepseek.com) — wiki compilation when the DeepSeek backend is selected. Your source text is sent to DeepSeek. Only outbound if DEEPSEEK_API_KEY is configured and selected as the compile model.
• Firecrawl (api.firecrawl.dev) — URL scraping fallback. The URL you pasted is sent to Firecrawl.
• GitHub public API (api.github.com) — when you paste a GitHub repo URL, Kompl fetches the README + metadata.
• YouTube (youtube.com + youtube.googleapis.com) — at compile time, captions via youtube-transcript-api, then metadata via YouTube Data API v3 (YOUTUBE_API_KEY required). Missing key → youtube_metadata_unavailable → Saved Links. No captions or blocked transcript → Saved Links too.
• OG-tag preview — pasted URLs are fetched once with User-Agent: KomplBot/1.0 to grab title + description.

One-time, on first use:

• HuggingFace Hub (huggingface.co) — ~90 MB download of the all-MiniLM-L6-v2 embedding model on the first compile. After that, no further HF traffic.

Build-time only: Docker image builds pull from PyPI, npm, Docker Hub, and apt mirrors. No runtime impact.

Kompl itself sends no analytics, no error reports, and no version pings. The bundled n8n container's upstream telemetry, version checks, templates, and personalization are disabled by default in docker-compose.yml.

Settings → Kompl Backup downloads a .kompl.zip containing your entire wiki: sources, compiled pages, provenance, extractions, and settings. API keys and third-party secrets are excluded. No LLM calls needed to restore.

To restore on a fresh instance: run setup, skip onboarding, go to Settings → Import Wiki, upload the .kompl.zip. All pages are immediately browsable and searchable. The search index rebuilds in the background after restore.

kompl start automatically saves a local backup to ~/.kompl/backups/kompl-backup.kompl.zip (at most once every 36 hours).

⚠️ Auto-backup-on-start is an early feature, wired end-to-end but lacking regression tests on the start-time path. Flag any silent skips.

kompl backup                                          # save to ~/.kompl/backups/kompl-backup.kompl.zip (overwrites)
kompl backup --output ~/Desktop/my-wiki.kompl.zip     # save to a custom path
kompl backup --schedule                               # register a weekly backup schedule (Monday 11:30)

--schedule is idempotent. Platform-specific behavior:

• Windows — registers a Task Scheduler entry (requires Admin). StartWhenAvailable means it runs on next login if the laptop was off at 11:30.
• Linux — appends a crontab entry (30 11 * * 1 kompl backup) for the current user. Standard cron does not catch up if the machine was off.
• macOS — uses crontab, same as Linux. Same caveat applies (cron does not catch up if the machine was off). Tested on Windows and Linux only — please open an issue if you hit anything weird on Mac.

⚠️ Integration tests wipe the database. bash scripts/integration-test.sh is destructive — it resets everything. Never run it on a wiki you want to keep. Use kompl backup first.

Known limitations:

• Single-tenant only — no user accounts or access control. Don't expose to the public internet without your own auth layer.
• Two LLM providers selectable per session: Gemini 2.5 (default) and DeepSeek V4 Pro.
• Gemini 2.5 + dense sources: structured-output truncation on inputs above ~50K chars (commonly academic PDFs and surveys) causes extract_llm_failed. Workaround: switch the session to DeepSeek V4 Pro in Settings — it handles up to ~200K chars cleanly without this pathology. Kompl does not auto-chunk long sources; if you'd rather stay on Gemini, split the source into smaller files yourself before ingesting. Tracked in issue #7.
• Current connectors: URLs (YouTube transcripts and GitHub READMEs included), file uploads (PDF, DOCX, PPTX, XLSX, TXT, MD, HTML), browser bookmarks, Twitter JSON export, Upnote, Apple Notes.
• No mobile app. The web UI works on mobile browsers but isn't optimized for small screens.

Kompl runs on a personal computer behind a loopback or LAN. The security posture is calibrated for that model.

Known security debt:

• Markdown HTML output is not yet sanitized — Firecrawl-scraped content can carry XSS payloads. Even on a single-user install, an ingested bookmark can deliver a payload; needs DOMPurify in the render pipeline.
• /convert/url does not yet share the SSRF gate that protects /metadata/peek.

CodeQL alerts. Some py/path-injection and js/path-injection alerts re-fire on every push because CodeQL's taint tracker doesn't follow cross-function sanitizers. We dismiss these individually (rather than silencing in CodeQL config) so any genuinely new sink in those files surfaces for review. The audit trail and per-alert reasoning live at docs/security/codeql-false-positives.md.

Reporting an issue. If you find something, please open a GitHub Security Advisory rather than a public issue.

Kompl's source is Apache-2.0 — see LICENSE. You can use, modify, fork, and redistribute it freely under those terms.

One caveat about the bundled n8n container. Kompl runs n8nio/n8n as an unmodified runtime dependency for workflow orchestration. n8n itself is licensed under the Sustainable Use License, which is not OSI-approved. In practice:

• Self-hosting Kompl for personal or internal use → fully fine.
• Forking and redistributing Kompl source → fine (Apache-2.0 covers Kompl; n8n is a runtime dep users pull themselves).
• Offering Kompl-as-a-hosted-service to third parties → this is the line. n8n's SUL restricts hosting n8n as a service for others; if your offering bundles n8n, contact n8n first.

See NOTICE for full attribution.