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

# InitRepo Quick Start Guide

> Get your complete InitRepo ecosystem up and running in under 10 minutes

## Choose Your InitRepo Journey

InitRepo offers three integrated tools. Choose your starting point based on your immediate needs:

<CardGroup cols={3}>
  <Card title="Generate New Documentation" icon="rocket" href="#web-platform-quickstart">
    Start with comprehensive project documentation generation
  </Card>

  <Card title="Analyze Existing Code" icon="magnifying-glass" href="#cli-tool-quickstart">
    Analyze existing codebases for insights and documentation
  </Card>

  <Card title="Enhance AI Assistants" icon="robot" href="#mcp-server-quickstart">
    Connect AI tools with structured project context
  </Card>
</CardGroup>

## Web Platform Quickstart

Generate comprehensive project documentation from scratch in 5 minutes.

### Prerequisites

* Modern web browser (Chrome, Firefox, Safari, Edge)
* Project idea or existing codebase to document
* Email address for account creation

<Tip>
  The Web Platform requires no local installation - everything runs in your browser.
</Tip>

### Step 1: Create Your Account

<Steps>
  <Step title="Visit InitRepo">
    Go to [initrepo.com](https://www.initrepo.com) and click "Get Started"
  </Step>

  <Step title="Sign Up">
    Choose your preferred authentication method:

    * Google OAuth (recommended)
    * GitHub OAuth
    * Email/password registration
  </Step>

  <Step title="Complete Profile">
    Fill in your basic profile information and preferences
  </Step>
</Steps>

### Step 2: Generate Your First Project Documentation

<Steps>
  <Step title="Choose Project Type">
    Select from:

    * **Web Applications**: Full-stack web development
    * **Mobile Apps**: Native and cross-platform mobile
    * **MCP Tools**: AI agent and workflow automation
    * **Rules-Based Systems**: Complex business logic automation
    * **Local Automation**: Python-based local scripts
  </Step>

  <Step title="Fill Project Questionnaire">
    Answer targeted questions about your project:

    * Project objectives and target audience
    * Core features and functionality requirements
    * Technical preferences and constraints
    * Timeline and resource considerations
  </Step>

  <Step title="AI Processing">
    Watch real-time progress as AI generates your documentation suite:

    * Business Analysis
    * Product Requirements Document
    * Technical Architecture
    * UX/UI Design Specifications
    * User Stories & Epics
    * Development Roadmap
  </Step>

  <Step title="Review & Export">
    Review generated documentation and export to your project
  </Step>
</Steps>

## CLI Tool Quickstart

Analyze existing codebases and generate intelligent insights in 3 minutes.

### Prerequisites

* Node.js 18+ installed
* Git installed
* Access to a codebase for analysis

<Tip>
  **Need help with installation?** Check our [detailed CLI installation guide](/cli/installation).
</Tip>

### Step 1: Install InitRepo CLI

<AccordionGroup>
  <Accordion icon="download" title="Global Installation (Recommended)">
    ```bash theme={null}
    npm install -g initrepo-cli
    ```

    Installs the InitRepo CLI globally for system-wide access.
  </Accordion>

  <Accordion icon="play" title="Direct Usage (No Installation)">
    ```bash theme={null}
    npx initrepo-cli --help
    ```

    Use InitRepo without installation for quick testing.
  </Accordion>

  <Accordion icon="code" title="From Source">
    ```bash theme={null}
    git clone https://github.com/initrepo/cli.git
    cd cli
    npm install
    npm run start -- --help
    ```

    Build from source for development and customization.
  </Accordion>
</AccordionGroup>

### Step 2: Analyze Your First Project

<Steps>
  <Step title="Navigate to Your Project">
    ```bash theme={null}
    cd /path/to/your/project
    ```

    Or clone a repository for analysis:

    ```bash theme={null}
    git clone https://github.com/your-org/your-repo
    cd your-repo
    ```
  </Step>

  <Step title="Run Basic Analysis">
    ```bash theme={null}
    # Quick project analysis
    initrepo-cli

    # Comprehensive analysis with JSON output
    initrepo-cli analyze --format=json
    ```

    This creates a `.initrepo/` directory with analysis results.
  </Step>

  <Step title="Generate Documentation">
    ```bash theme={null}
    # Generate project structure documentation
    initrepo-cli generate-structure --format=tree

    # Analyze code complexity
    initrepo-cli analyze-complexity --threshold=10

    # Check import health
    initrepo-cli analyze-imports --unused-only
    ```
  </Step>

  <Step title="View Results">
    ```bash theme={null}
    # View generated files
    ls -la .initrepo/

    # View structure documentation
    cat .initrepo/project-structure.md
    ```
  </Step>
</Steps>

### Step 3: Advanced Analysis (Optional)

<AccordionGroup>
  <Accordion icon="chart-line" title="Quality Assessment">
    ```bash theme={null}
    # Get quality score
    initrepo-cli validate-structure --format=json

    # Generate comprehensive report
    initrepo-cli analyze-complexity --with-recommendations
    ```
  </Accordion>

  <Accordion icon="tools" title="Safe Refactoring">
    ```bash theme={null}
    # Preview symbol rename
    initrepo-cli safe-rename oldFunction newFunction --dry-run

    # Apply the rename
    initrepo-cli safe-rename oldFunction newFunction
    ```
  </Accordion>

  <Accordion icon="automation" title="CI/CD Integration">
    ```bash theme={null}
    # Quality gates for CI/CD
    initrepo-cli validate-structure --format=json > structure.json
    initrepo-cli analyze-complexity --format=json > complexity.json
    ```
  </Accordion>
</AccordionGroup>

## MCP Server Quickstart

Connect AI coding assistants with structured project context in 5 minutes.

### Prerequisites

* InitRepo documentation (from Web Platform or existing project)
* AI coding assistant (Claude Code, Cursor, VS Code, etc.)
* Node.js 18+ installed

<Warning>
  The MCP Server ONLY works with InitRepo-generated documentation. Generate documentation first using the Web Platform.
</Warning>

### Step 1: Install InitRepo MCP Server

<Steps>
  <Step title="Install via npm">
    ```bash theme={null}
    npm install -g initrepo-mcp
    ```

    This installs the MCP server globally.
  </Step>

  <Step title="Verify Installation">
    ```bash theme={null}
    initrepo-mcp --version
    ```

    Should display the server version and available tools.
  </Step>

  <Step title="Test Server">
    ```bash theme={null}
    initrepo-mcp --help
    ```

    Shows available configuration options and commands.
  </Step>
</Steps>

### Step 2: Configure Your AI Assistant

<Tabs>
  <Tab title="Claude Code (Quick Setup)">
    **Fastest option - use the built-in command:**

    ```bash theme={null}
    claude mcp add --transport http initrepo https://mcp.initrepo.com/
    ```

    This automatically:

    * Connects to the InitRepo MCP server
    * Opens authentication in your browser
    * Provides 37+ specialized development tools

    **Alternative manual configuration:**

    ```json theme={null}
    {
      "mcp": {
        "servers": {
          "initrepo": {
            "command": "initrepo-mcp",
            "args": []
          }
        }
      }
    }
    ```
  </Tab>

  <Tab title="Cursor">
    Configure in `.cursorrules` or settings:

    ```json theme={null}
    {
      "mcpServers": {
        "initrepo-mcp": {
          "command": "initrepo-mcp",
          "args": []
        }
      }
    }
    ```
  </Tab>

  <Tab title="VS Code">
    Install MCP extension and add:

    ```json theme={null}
    {
      "mcp.servers": {
        "initrepo": {
          "command": "initrepo-mcp",
          "args": [],
          "env": {}
        }
      }
    }
    ```
  </Tab>
</Tabs>

### Step 3: Verify MCP Integration

<Steps>
  <Step title="Check Documentation">
    Ensure your project has InitRepo documentation in `/docs` folder with proper IDs (T-001, US-001, etc.)
  </Step>

  <Step title="Test Connection">
    Ask your AI assistant: "What InitRepo tools are available?"
  </Step>

  <Step title="Test Intelligence">
    Try: "Show me the context for task T-001" or "Generate an implementation brief for US-001"
  </Step>
</Steps>

## Complete Integration Example

Let's walk through integrating all three InitRepo tools:

<Steps>
  <Step title="Generate Documentation">
    1. Visit [initrepo.com](https://www.initrepo.com)
    2. Create a "Web Application" project
    3. Answer the questionnaire about your Node.js API
    4. Download generated documentation to `/docs` folder
  </Step>

  <Step title="Analyze Your Codebase">
    ```bash theme={null}
    # Install CLI
    npm install -g initrepo-cli

    # Analyze your project
    cd your-project
    initrepo-cli analyze --format=json

    # Generate structure docs
    initrepo-cli generate-structure --format=tree
    ```
  </Step>

  <Step title="Connect AI Assistant">
    ```bash theme={null}
    # Install MCP server
    npm install -g initrepo-mcp

    # Configure your AI assistant (see tabs above)
    # Test with: "What are my highest priority tasks?"
    ```
  </Step>
</Steps>

## What You Get

After completing setup, you have access to:

<AccordionGroup>
  <Accordion title="Web Platform Benefits">
    ✅ **Comprehensive Documentation** - 6 complete documentation types
    ✅ **AI-Ready Format** - Structured for perfect AI assistant integration
    ✅ **Team Collaboration** - Shared workspaces and real-time editing
    ✅ **Export Options** - Multiple formats and GitHub integration
  </Accordion>

  <Accordion title="CLI Tool Capabilities">
    ✅ **Code Intelligence** - Deep analysis of project structure and quality
    ✅ **Safe Refactoring** - AST-based modifications with integrity preservation
    ✅ **CI/CD Integration** - Automated quality gates and reporting
    ✅ **Team Standards** - Consistent analysis across development teams
  </Accordion>

  <Accordion title="MCP Server Intelligence">
    ✅ **37+ Specialized Tools** - Comprehensive project analysis capabilities
    ✅ **Context Generation** - Transform documentation into AI-ready context
    ✅ **Progress Tracking** - Real-time task completion and dependency analysis
    ✅ **Risk Assessment** - Proactive identification of project challenges
  </Accordion>
</AccordionGroup>

## Next Steps

Now that you have the complete InitRepo ecosystem set up:

<CardGroup cols={3}>
  <Card title="Platform Deep Dive" icon="map" href="/platform/overview">
    Learn about advanced platform features and enterprise capabilities
  </Card>

  <Card title="CLI Mastery" icon="terminal" href="/cli/installation">
    Master advanced CLI commands and automation workflows
  </Card>

  <Card title="MCP Integration" icon="server" href="/mcp/overview">
    Explore all 37+ MCP tools and advanced AI assistant features
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="AI IDE Setup" icon="code" href="/integrations/cursor">
    Complete setup guides for Cursor, VS Code, JetBrains, and more
  </Card>

  <Card title="Team Workflows" icon="users" href="/platform/overview#team-collaboration-workflow">
    Set up team collaboration and shared development practices
  </Card>
</CardGroup>

<Note>
  **Need help?** Join our [Discord community](https://discord.gg/7HJmEzrY4d) or check the [troubleshooting guide](/advanced/troubleshooting).
</Note>