What is Kompl AGENTS.md?

An operating guide for Kompl, a tool that turns saved links, files, and bookmarks into a connected personal wiki. It also sets safety rules for Docker commands that could erase the wiki.

Use it when installing, updating, backing up, configuring, or safely operating Kompl.

It gives an agent the project’s operating instructions and helps prevent accidental loss of the wiki’s stored data.

How tuirk/Kompl configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to tuirk/Kompl. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/tuirk/Kompl/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/tuirk/Kompl

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/tuirk/kompl/agents-md/github.svg)](https://agentmods.dev/instructions/tuirk/kompl/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/tuirk/kompl/agents-md"><img src="https://agentmods.dev/badge/instructions/tuirk/kompl/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/tuirk/kompl/agents-md"><img src="https://agentmods.dev/badge/instructions/tuirk/kompl/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,558 This file is loaded in full into every session.

When invoked 1,558 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01558	$0.01558
Opus 5.5	$0.00623	$0.00623
Sonnet 5.5	$0.00312	$0.00312
Haiku 4.5	$0.00156	$0.00156

Measured 10d ago against content hash bf08b9dbb3ae, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

Kompl AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 135 lines

How it starts

The opening of the file, as written. The whole thing — 135 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — helping someone set up and run Kompl

For AI agents (Claude Code, Codex, Cursor, Gemini CLI and others) helping a user install, run, update or connect Kompl from this repo.

README.md is the source of truth for every step. This file adds the rules and pitfalls agents most often get wrong.

What Kompl is

Kompl turns saved links, files and bookmarks into an interlinked wiki when each source arrives, not when someone asks later. It runs locally as a Docker stack: the app at http://localhost:3000, an NLP service and n8n. The user's wiki lives on the Docker volume kompl-data, and the kompl CLI starts, stops, updates and backs it up. Once installed, the repo path is projectDir in ~/.kompl/config.json.

Installing

Needs Docker running, Node.js 24+, about 5 GB of disk and 4 GB of free RAM, a Firecrawl key and a DeepSeek or Gemini key (YouTube is optional). See README § Quick start and README § API keys.

node setup.js from the repo root asks for the API keys, writes .env, installs the kompl CLI, builds the MCP server and starts the stack. It prompts interactively, so in a shell that can't answer prompts:

Copy .env.example to .env.
Ask the user to paste their keys into .env themselves. Keys should not pass through your conversation, and .env must never be committed or shared.
Run node setup.js. With FIRECRAWL_API_KEY and one of DEEPSEEK_API_KEY / GEMINI_API_KEY already set, it skips the prompts.

The first start takes 5–10 minutes while Docker builds the images. Run kompl status until the app is healthy, then kompl open.

Wiki safety (read before any Docker command)

One flag can delete the user's entire wiki (database, pages and search index). Treat that as irreversible unless they have a .kompl.zip backup.

Never without explicit confirmation

Do not run, suggest or script any of these unless the user has said in this conversation that they accept losing their wiki, or the install is a fresh one with nothing to lose:

Read the full file on GitHub · 135 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

10d ago Changed · +12 lines · -174 tokens per session bf08b9dbb3ae
2mo ago Changed · +44 lines · +641 tokens per session c1932775d5c3
2mo ago First seen · 79 lines · 1,091 tokens per session scan A f248063befea

Subscribe to this mod's changes

Kompl AGENTS.md is an instructions file published in the GitHub repository tuirk/Kompl (82 stars, last pushed 2d ago), licensed Apache-2.0. It adds 1,558 tokens to every session, about $0.0062 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

LLM Memory and context Research knowledge-management llm-wiki mcp personal-knowledge-management pkm

Kompl AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
Kompl AGENTS.mdtuirk/Kompl	Instructions file	82	2d ago	Apache-2.0	A	1,558	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

Kompl: Instructions file for Codex