> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codealive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with CodeAlive in minutes

## Start Using CodeAlive in Three Simple Steps

Transform your AI coding experience with deep contextual understanding of your codebase.

> [!NOTE]
>
> Add at least one repository before connecting an assistant. Current remote MCP clients can use browser OAuth without an API key; API keys remain available for direct API, Docker, and compatibility setups. Chat and search become useful after your repository is indexed.

**1. Create Your CodeAlive Account**

> [accordion] Sign up
>
> 1. Visit [app.codealive.ai](https://app.codealive.ai) to create your account
> 2. Complete the registration process

> [accordion] Add your first repository
>
> Once logged in:
>
> 1. Navigate to the **Data Sources** section
>
> 2. Connect your GitHub, GitLab, or Bitbucket repositories
>
> 3. Select at least one repository to add to CodeAlive
>
> 4. CodeAlive will begin building your codebase knowledge graph
>
> > [!TIP]
> >
> > Once at least one repository has been added, you can create an API key right away. Initial indexing typically takes 5-15 minutes depending on repository size.

> [accordion] Create your API key
>
> 1. Navigate to **MCP & API** in the dashboard
>
> 2. Click **"+ Create API Key"**
>
> 3. Copy your key immediately (it won't be displayed again)
>
> > [!WARNING]
> >
> > Save your API key securely. You will need it to connect your AI assistants, and it cannot be retrieved later.

**2. Connect Your AI Assistant**

Choose your preferred integration method:

> [tab] Installer (Recommended)
>
> ### One-Command Setup
>
> The installer auto-detects your AI agents and configures CodeAlive:
>
> ```bash theme={null}
> npx @codealive/installer
> ```
>
> Supports Claude Code, Cursor, VS Code, Windsurf, Cline, Codex, and more. See the [Installation Guide](https://docs.codealive.ai/installation.md) for details.

> [tab] MCP (Manual)
>
> ### Model Context Protocol Setup
>
> For an OAuth-capable remote MCP client:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "codealive": {
>       "url": "https://mcp.codealive.ai/api"
>     }
>   }
> }
> ```
>
> > [!NOTE]
> >
> > Your client opens CodeAlive in a browser for sign-in and consent. If it does not prompt automatically, use its MCP login command. The agent-specific guides include exact steps and an API-key fallback.
>
> See [MCP Integration](https://docs.codealive.ai/integrations/mcp.md) for agent-specific instructions.

> [tab] API Integration
>
> ### Direct API Integration
>
> Use CodeAlive's REST API directly:
>
> ```bash theme={null}
> curl -X POST https://app.codealive.ai/api/tools/chat \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "question": "Explain the authentication flow. Prior context: none.",
>     "data_sources": ["your-repo-name"],
>     "output_format": "agentic"
>   }'
> ```

> [tab] Docker
>
> ### Local Docker Setup
>
> Run CodeAlive MCP server locally:
>
> ```bash theme={null}
> docker run -p 8000:8000 \
>   -e CODEALIVE_API_KEY=YOUR_API_KEY \
>   ghcr.io/codealive-ai/codealive-mcp:main
> ```

**3. Start Using CodeAlive**

> [!TIP]
>
> Wait until your repository finishes indexing before expecting useful chat or search results.

> [accordion] Semantic Code Search
>
> Try these example queries:
>
> * "Find all authentication-related code"
> * "Show me error handling patterns in the payment service"
> * "Locate database connection configurations"

> [accordion] Contextual Chat
>
> Engage in deep technical discussions:
>
> * "How does the user registration flow work?"
> * "What are the potential security vulnerabilities in the API endpoints?"
> * "Suggest improvements for the caching strategy"

> [accordion] Code Review
>
> Get AI-powered code reviews:
>
> * "Review this pull request for best practices"
> * "Check for potential performance issues"
> * "Identify code duplication across the codebase"

## Integration Guides

> [card] [Installation Guide](https://docs.codealive.ai/installation.md)
>
> One-command installer for all agents

> [card] [Claude Code](https://docs.codealive.ai/integrations/mcp/claude-code.md)
>
> Set up CodeAlive with Claude Code

> [card] [Cursor](https://docs.codealive.ai/integrations/mcp/cursor.md)
>
> Integrate CodeAlive into Cursor

> [card] [VS Code + Copilot](https://docs.codealive.ai/integrations/mcp/vscode.md)
>
> Use CodeAlive with GitHub Copilot in VS Code

> [card] [All Agents](https://docs.codealive.ai/integrations/mcp.md)
>
> 20+ agent integrations including Windsurf, Codex, Gemini CLI, and more

> [card] [API Reference](https://docs.codealive.ai/api-reference/toolapi/list-visible-data-sources.md)
>
> Explore the full API documentation

## Key Benefits

> [accordion] 83% Faster AI Responses
>
> CodeAlive's context engine dramatically improves AI response times by providing pre-indexed, semantically organized code knowledge.

> [accordion] Multi-Repository Support
>
> Analyze relationships across multiple repositories simultaneously, perfect for microservices architectures.

> [accordion] All Languages Supported
>
> Support for all programming languages and frameworks in your tech stack.

## Troubleshooting

> [accordion] Repository not indexing
>
> * Ensure you have proper access permissions to the repository
> * Check that the repository is not empty
> * For private repos, verify your GitHub/GitLab/Bitbucket integration is properly configured

> [accordion] API key not working
>
> * Verify you're using the correct API key from your dashboard
> * Make sure you have added at least one repository before trying to create a key
> * Check that your account is active
> * Ensure proper formatting in your configuration (Bearer token in Authorization header)

> [accordion] Slow response times
>
> * Initial repository indexing may take time for large codebases
> * Check your network connection
> * Contact [support@codealive.ai](mailto:support@codealive.ai) if issues persist

## Next Steps

> [card] [Documentation](https://docs.codealive.ai/api-reference/toolapi/list-visible-data-sources.md)
>
> Learn about CodeAlive's architecture

> [card] [Best Practices](https://docs.codealive.ai/tips-and-tricks.md)
>
> Optimize your CodeAlive setup

> [card] [Support](mailto:support@codealive.ai)
>
> Get help from our team


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.