LynxPrompt is a self-hosted web app that turns one set of AI coding rules into the file each tool reads: AGENTS.md, CLAUDE.md, .cursor/rules/, Copilot instructions, 30 rule-file formats in all, plus slash commands for six of them. A wizard writes the rules from your stack, blueprints let a team share them with variables, and the lynxp CLI and the VS Code extension put the files into every repository. Run it with Docker Compose or the Helm chart, or try the hosted instance at lynxprompt.geiser.cloud first.
The official instance is https://lynxprompt.geiser.cloud. It replaces lynxprompt.com, which keeps serving the API until the domain lapses in December 2026; a CLI still set to lynxprompt.com switches to the new address, with its login, on its next run after an update.
Features
- One set of rules for 26 coding agents, kept in one
AGENTS.md: Codex, Cursor, Devin Desktop (formerly Windsurf), Antigravity, Zed, Cline, Junie, Goose, Warp and most others read it directly; Claude Code and Gemini CLI get a one-line import, Aider a config that loads it, and Copilot, Trae and Tabnine a full copy in their own file. Slash commands for 18 of them.
- A 12-step wizard on the web or in the terminal builds the rules from your project, stack, commands, code style and boundaries;
lynxp analyze reads an existing repository first.
- Blueprints carry
[[VARIABLE|default]] placeholders, so one blueprint fits many projects.
- Each blueprint is private, shared with a team or public; teams get their own page. Federation is opt-in and only lists the instances that join in a shared directory.
- Hierarchical
AGENTS.md for monorepos, managed from the dashboard, the CLI and the API.
- The
lynxp CLI (19 commands: wizard, check, analyze, convert, diff, pull, push, search and more) and the VS Code extension work against any instance.
- Sign in with a magic link, passkeys, GitHub or Google OAuth, or OIDC SSO; each is one environment variable.
- Optional AI editing with your own Anthropic API key; off by default, everything else works without it.
- Docker Compose or Helm, PostgreSQL included, migrations on start, every feature an environment variable.
Quick start
curl -O https://raw.githubusercontent.com/GeiserX/LynxPrompt/main/docker-compose.selfhost.yml -O https://raw.githubusercontent.com/GeiserX/LynxPrompt/main/docker-compose.mailpit.yml
(umask 077; printf 'NEXTAUTH_SECRET=%s\nDB_PASSWORD=%s\[email protected]\n' "$(openssl rand -base64 32)" "$(openssl rand -hex 24)" > .env)
docker compose -f docker-compose.selfhost.yml -f docker-compose.mailpit.yml up -d
Put your own address in ADMIN_EMAIL, open http://localhost:3000, sign in with it, and read the sign-in link at http://localhost:8025 (Mailpit, a local mailbox for trying it out); the dashboard opens and that account is the superadmin. For a real deployment set the SMTP_* variables in .env and drop the Mailpit file; the image runs natively on amd64 and arm64. Helm, the CLI and the other install channels are in Getting started.
Documentation
The documentation lives at geiserx.github.io/LynxPrompt.
- Getting started: Docker Compose, the first sign-in, the Helm chart, every install channel
- Configuration: every environment variable and its default
- Usage: the web app, the CLI, the VS Code extension and the API
- Features: the full list of formats and what each feature does
- How it works: components, sign-in, what the CLI talks to, the security model
- Troubleshooting: the sign-in mail, ARM hosts, ports, what to include in a bug report
- Development: stack, local setup, the docs build
The product manual for using LynxPrompt (the wizard, blueprints, the CLI and API reference) is a separate site at lynxprompt.geiser.cloud/docs.
Related projects
| Project | Type | Description |
|---|
| lynxprompt-mcp | MCP server | Browse and manage blueprints from AI assistants over the Model Context Protocol |
| lynxprompt-vscode | VS Code extension | Pull, diff and push AI config files without leaving the editor |
| homebrew-lynxprompt | Homebrew tap | brew install GeiserX/lynxprompt/lynxprompt on macOS and Linux |
| lynxprompt-action | GitHub Action | Sync, validate, generate and diff AI IDE configuration files in CI |
License
AGPL-3.0-or-later
