# LynxPrompt - Full Documentation for LLMs

> Your universal AI config hub

LynxPrompt is a web platform and CLI for generating and sharing AI IDE configuration files and commands (workflows). This document is auto-generated from the codebase.

Website: https://lynxprompt.com
GitHub: https://github.com/GeiserX/LynxPrompt

## Overview

LynxPrompt solves the problem of manually writing AI configuration files like AGENTS.md, CLAUDE.md, .cursor/rules/, or .github/copilot-instructions.md for every project. Users can:

1. Use the **Configuration Wizard** to generate configs step-by-step
2. Browse the **Blueprint Marketplace** to download community-created configs
3. Use the **CLI** to generate configs locally or sync with the cloud

### Core Concepts

- **AI Configs**: Rules and instructions that define how AI assistants behave in your project
- **Commands (Workflows)**: Slash commands that execute specific workflows on demand (e.g., /security-audit)
- **Blueprints**: Shareable, versioned config templates with [[VARIABLE]] placeholders

## Supported Platforms (30 AI IDEs & Tools)

### Popular Platforms
- **Universal (AGENTS.md)**: `AGENTS.md` - Works with Claude Code, Copilot, Aider, and many others
- **Cursor**: `.cursor/rules/` - AI-powered code editor with native rules
- **Claude Code**: `CLAUDE.md` - Anthropic's agentic coding tool
- **GitHub Copilot**: `.github/copilot-instructions.md` - GitHub's AI pair programmer
- **Windsurf**: `.windsurfrules` - Codeium's AI-native IDE

### AI-Powered IDEs
- **Antigravity**: `GEMINI.md` - Google's Gemini-powered IDE
- **Zed**: `.zed/instructions.md` - High-performance editor with AI
- **Void**: `.void/config.json` - Open-source Cursor alternative
- **Trae AI**: `.trae/rules/` - ByteDance's AI IDE
- **Firebase Studio**: `.idx/` - Google's cloud IDE

### Editor Extensions
- **Cline**: `.clinerules` - Autonomous coding agent for VS Code
- **Roo Code**: `.roo/rules/` - AI coding assistant for VS Code
- **Continue**: `.continue/config.json` - Open-source AI autopilot
- **Sourcegraph Cody**: `.cody/config.json` - Context-aware AI assistant
- **Tabnine**: `.tabnine.yaml` - AI code completion
- **Supermaven**: `.supermaven/config.json` - Fast AI code completions
- **CodeGPT**: `.codegpt/config.json` - VS Code AI assistant
- **Amazon Q**: `.amazonq/rules/` - AWS AI coding companion
- **Augment Code**: `.augment/rules/` - AI code augmentation
- **Kilo Code**: `.kilocode/rules/` - AI code generation
- **Junie**: `.junie/guidelines.md` - JetBrains AI assistant
- **Kiro**: `.kiro/steering/` - AWS spec-driven agent

### CLI Tools
- **Aider**: `AIDER.md` - AI pair programming in terminal
- **Goose**: `.goosehints` - Block's AI coding agent
- **Warp AI**: `WARP.md` - AI-powered terminal
- **Gemini CLI**: `GEMINI.md` - Google's Gemini in terminal
- **Open Code**: `opencode.json` - Open-source AI coding

### Other Tools
- **OpenHands**: `.openhands/microagents/repo.md` - Open-source AI agent
- **Crush**: `CRUSH.md` - AI coding assistant
- **Firebender**: `firebender.json` - AI code transformation


## Supported Commands/Workflows (6 platforms)

Commands are slash commands invoked with /command-name:

- **Cursor Command**: .cursor/commands/ - Custom slash commands for Cursor IDE (e.g., /deploy, /test)
- **Claude Code Command**: .claude/commands/ - Custom slash commands for Claude Code (e.g., /review, /refactor)
- **Windsurf Workflow**: .windsurf/workflows/ - Cascade workflows for Windsurf IDE
- **Copilot Prompt**: .copilot/prompts/ - Custom prompts for GitHub Copilot Chat
- **Continue Prompt**: .continue/prompts/ - Invokable prompts for Continue.dev extension
- **OpenCode Command**: .opencode/commands/ - Custom commands for OpenCode TUI

## Features

### Configuration Wizard
Step-by-step generator that creates AI config files tailored to your project.
- Auto-detect: Detects tech stack, frameworks, databases from codebase and GitHub/GitLab URLs
- Dynamic Sections: Tech stack, code style, testing, CI/CD, branch strategy, security rules
- Sensitive Data Detection: Warns about potential secrets before sharing
- Wizard Drafts: Auto-saves progress to continue later
- Multiple Formats: Export to any supported AI IDE format
- Guest Mode: Use without signing up (login required to save/share)

### Blueprint Marketplace
Browse, share, and sell AI configurations and commands.
- Two Types: AI Configs (rules/instructions) and Commands (slash commands/workflows)
- Categories & Tags: Filter by category, platform, and tags
- Search: Full-text search across all blueprints
- Favorites: Save blueprints to your favorites list
- Community Blueprints: Share and discover blueprints across the marketplace
- Public Profiles: Author pages with social links and blueprints
- Versioning: Track changes with changelogs

### Template Variables
Use [[VARIABLE]] or [[VARIABLE|default]] placeholders for dynamic inputs. Variables are replaced when downloading or using blueprints.

### Teams
Collaborate on AI configurations within your organization.
- Team Blueprints: Share blueprints only with team members (Private, Team, or Public visibility)
- Centralized Management: Single dashboard for the entire team
- AI Editing: AI-assisted blueprint creation and editing
- SSO Support: SAML 2.0 (Okta, Azure AD), OpenID Connect (Google Workspace, Auth0)

### Monorepo Support
First-class support for monorepo architectures.
- Hierarchy: Define parent-child relationships between AGENTS.md files
- Auto-detect: CLI detects AGENTS.md files in subfolders
- Bulk Creation: Offer bulk hierarchy creation for detected files

### API Access
REST API for programmatic access.
- GET /api/v1/blueprints - List public blueprints
- GET /api/v1/blueprints/{id} - Get specific blueprint
- Authentication via Bearer token (generate at /settings?tab=api-tokens)

## CLI Reference

Install via npm, Homebrew, or Chocolatey:
- npm install -g lynxprompt
- brew install GeiserX/lynxprompt/lynxprompt
- choco install lynxprompt

### Commands
- lynxp wizard - Interactive config generator with auto-detection
- lynxp wizard -y - Quick generation with defaults (creates AGENTS.md)
- lynxp wizard -f <format> - Generate for specific format
- lynxp pull <blueprint_id> - Download blueprint from marketplace
- lynxp push - Upload local configs to your account
- lynxp status - Check linked configs and hierarchy
- lynxp import - Import existing AGENTS.md files
- lynxp convert - Convert between formats
- lynxp analyze - Analyze project and output detected stack
- lynxp hierarchy - Manage monorepo parent-child relationships
- lynxp login - Authenticate with LynxPrompt

## Authentication

Multiple sign-in methods:
- OAuth Providers: GitHub, Google
- Magic Link: Passwordless email login
- Passkeys: WebAuthn biometric/hardware key authentication
- Linked Accounts: Connect multiple providers to one account

## Plans

- Users (Free): Full wizard access, browse & download blueprints, share blueprints, API access
- Teams (Free): Everything in Users + AI editing, team blueprints, SSO, centralized management

## Documentation Structure

### Getting Started
Learn the basics of LynxPrompt and get up and running quickly.
  - Introduction: https://lynxprompt.com/docs/getting-started
  - Quick Start: https://lynxprompt.com/docs/getting-started/quick-start
  - Account Setup: https://lynxprompt.com/docs/getting-started/account

### Self-Hosting
Run your own LynxPrompt instance with Docker.
  - Self-Hosting Guide: https://lynxprompt.com/docs/self-hosting

### Wizard
Master the configuration wizard to generate perfect AI IDE configs.
  - Full Wizard Guide: https://lynxprompt.com/docs/wizard

### Blueprints
Create, share, and discover AI configuration blueprints.
  - Overview: https://lynxprompt.com/docs/blueprints
  - Browsing & Downloading: https://lynxprompt.com/docs/blueprints/browsing
  - Creating Blueprints: https://lynxprompt.com/docs/blueprints/creating
  - Commands & Workflows: https://lynxprompt.com/docs/blueprints/commands
  - Template Variables: https://lynxprompt.com/docs/blueprints/variables
  - Monorepo Hierarchy: https://lynxprompt.com/docs/blueprints/hierarchy

### Marketplace
Discover and share community blueprints.
  - Overview: https://lynxprompt.com/docs/marketplace

### AI Features
AI-powered editing and enhancement capabilities.
  - Overview: https://lynxprompt.com/docs/ai-features
  - AI Blueprint Editing: https://lynxprompt.com/docs/ai-features/editing
  - Wizard AI Assistant: https://lynxprompt.com/docs/ai-features/wizard-assistant

### Supported Platforms
All the AI IDEs and tools LynxPrompt supports (30+).
  - Overview: https://lynxprompt.com/docs/platforms
  - Popular Platforms: https://lynxprompt.com/docs/platforms/popular
  - AI-Powered IDEs: https://lynxprompt.com/docs/platforms/ides
  - Editor Extensions: https://lynxprompt.com/docs/platforms/editors
  - CLI Tools: https://lynxprompt.com/docs/platforms/cli
  - AGENTS.md Standard: https://lynxprompt.com/docs/platforms/agents-md

### CLI
Generate configurations from your terminal with the LynxPrompt CLI.
  - Overview: https://lynxprompt.com/docs/cli
  - Installation: https://lynxprompt.com/docs/cli/installation
  - Authentication: https://lynxprompt.com/docs/cli/authentication
  - Commands: https://lynxprompt.com/docs/cli/commands

### API Reference
Programmatically manage blueprints with our REST API.
  - Overview: https://lynxprompt.com/docs/api
  - Authentication: https://lynxprompt.com/docs/api/authentication
  - Blueprints API: https://lynxprompt.com/docs/api/blueprints
  - User API: https://lynxprompt.com/docs/api/user

### Federation
Connect multiple LynxPrompt instances for cross-instance discovery.
  - Federation Overview: https://lynxprompt.com/docs/federation

### FAQ
Frequently asked questions and troubleshooting.
  - General Questions: https://lynxprompt.com/docs/faq
  - Troubleshooting: https://lynxprompt.com/docs/faq/troubleshooting
  - Support & Feedback: https://lynxprompt.com/docs/faq/support

## Quick Start

### Web App
1. Visit https://lynxprompt.com
2. Sign in with GitHub, Google, or email
3. Use the wizard or browse blueprints
4. Download your configuration files

### CLI
npm install -g lynxprompt
lynxp wizard

### API
curl https://lynxprompt.com/api/v1/blueprints
curl -H "Authorization: Bearer lp_xxxxx" https://lynxprompt.com/api/v1/blueprints/bp_abc123

## Links

- Website: https://lynxprompt.com
- Documentation: https://lynxprompt.com/docs
- CLI Docs: https://lynxprompt.com/docs/cli
- API Docs: https://lynxprompt.com/docs/api
- Blueprints: https://lynxprompt.com/blueprints
- GitHub: https://github.com/GeiserX/LynxPrompt
- Support: https://lynxprompt.com/support