InitRepo Quick Start Guide

Choose Your InitRepo Journey

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

Generate New Documentation

Start with comprehensive project documentation generation

Analyze Existing Code

Analyze existing codebases for insights and documentation

Enhance AI Assistants

Connect AI tools with structured project context

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

The Web Platform requires no local installation - everything runs in your browser.

Step 1: Create Your Account

Visit InitRepo

Go to initrepo.com and click “Get Started”

Choose your preferred authentication method:

Google OAuth (recommended)
GitHub OAuth
Email/password registration

Complete Profile

Fill in your basic profile information and preferences

Step 2: Generate Your First Project Documentation

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

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

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

Review & Export

Review generated documentation and export to your project

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

Need help with installation? Check our detailed CLI installation guide.

Step 1: Install InitRepo CLI

Global Installation (Recommended)

npm install -g initrepo-cli

Installs the InitRepo CLI globally for system-wide access.

Direct Usage (No Installation)

npx initrepo-cli --help

Use InitRepo without installation for quick testing.

From Source

git clone https://github.com/initrepo/cli.git
cd cli
npm install
npm run start -- --help

Build from source for development and customization.

Step 2: Analyze Your First Project

Navigate to Your Project

cd /path/to/your/project

Or clone a repository for analysis:

git clone https://github.com/your-org/your-repo
cd your-repo

Run Basic Analysis

# Quick project analysis
initrepo-cli

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

This creates a .initrepo/ directory with analysis results.

Generate Documentation

# 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

View Results

# View generated files
ls -la .initrepo/

# View structure documentation
cat .initrepo/project-structure.md

Step 3: Advanced Analysis (Optional)

Quality Assessment

# Get quality score
initrepo-cli validate-structure --format=json

# Generate comprehensive report
initrepo-cli analyze-complexity --with-recommendations

Safe Refactoring

# Preview symbol rename
initrepo-cli safe-rename oldFunction newFunction --dry-run

# Apply the rename
initrepo-cli safe-rename oldFunction newFunction

CI/CD Integration

# Quality gates for CI/CD
initrepo-cli validate-structure --format=json > structure.json
initrepo-cli analyze-complexity --format=json > complexity.json

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

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

Step 1: Install InitRepo MCP Server

Install via npm

npm install -g initrepo-mcp

This installs the MCP server globally.

Verify Installation

initrepo-mcp --version

Should display the server version and available tools.

Test Server

initrepo-mcp --help

Shows available configuration options and commands.

Step 2: Configure Your AI Assistant

Claude Code (Quick Setup)
Cursor
VS Code

Fastest option - use the built-in command:

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:

{
  "mcp": {
    "servers": {
      "initrepo": {
        "command": "initrepo-mcp",
        "args": []
      }
    }
  }
}

Configure in .cursorrules or settings:

{
  "mcpServers": {
    "initrepo-mcp": {
      "command": "initrepo-mcp",
      "args": []
    }
  }
}

Install MCP extension and add:

{
  "mcp.servers": {
    "initrepo": {
      "command": "initrepo-mcp",
      "args": [],
      "env": {}
    }
  }
}

Step 3: Verify MCP Integration

Check Documentation

Ensure your project has InitRepo documentation in /docs folder with proper IDs (T-001, US-001, etc.)

Test Connection

Ask your AI assistant: “What InitRepo tools are available?”

Test Intelligence

Try: “Show me the context for task T-001” or “Generate an implementation brief for US-001”

Complete Integration Example

Let’s walk through integrating all three InitRepo tools:

Generate Documentation

Visit initrepo.com
Create a “Web Application” project
Answer the questionnaire about your Node.js API
Download generated documentation to /docs folder

Analyze Your Codebase

# 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

Connect AI Assistant

# Install MCP server
npm install -g initrepo-mcp

# Configure your AI assistant (see tabs above)
# Test with: "What are my highest priority tasks?"

What You Get

After completing setup, you have access to:

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

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

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

Next Steps

Now that you have the complete InitRepo ecosystem set up:

Platform Deep Dive

Learn about advanced platform features and enterprise capabilities

CLI Mastery

Master advanced CLI commands and automation workflows

MCP Integration

Explore all 37+ MCP tools and advanced AI assistant features

AI IDE Setup

Complete setup guides for Cursor, VS Code, JetBrains, and more

Team Workflows

Set up team collaboration and shared development practices

Need help? Join our Discord community or check the troubleshooting guide.

Getting Started

Plans & Pricing

Security & Compliance

MCP Server

CLI Tool

InitRepo Quick Start Guide

Choose Your InitRepo Journey

Generate New Documentation

Analyze Existing Code

Enhance AI Assistants

Web Platform Quickstart

Prerequisites

Step 1: Create Your Account

Step 2: Generate Your First Project Documentation

CLI Tool Quickstart

Prerequisites

Step 1: Install InitRepo CLI

Step 2: Analyze Your First Project

Step 3: Advanced Analysis (Optional)

MCP Server Quickstart

Prerequisites

Step 1: Install InitRepo MCP Server

Step 2: Configure Your AI Assistant

Step 3: Verify MCP Integration

Complete Integration Example

What You Get

Next Steps

Platform Deep Dive

CLI Mastery

MCP Integration

AI IDE Setup

Team Workflows

​Choose Your InitRepo Journey

Generate New Documentation

Analyze Existing Code

Enhance AI Assistants

​Web Platform Quickstart

​Prerequisites

​Step 1: Create Your Account

​Step 2: Generate Your First Project Documentation

​CLI Tool Quickstart

​Prerequisites

​Step 1: Install InitRepo CLI

​Step 2: Analyze Your First Project

​Step 3: Advanced Analysis (Optional)

​MCP Server Quickstart

​Prerequisites

​Step 1: Install InitRepo MCP Server

​Step 2: Configure Your AI Assistant

​Step 3: Verify MCP Integration

​Complete Integration Example

​What You Get

​Next Steps

Platform Deep Dive

CLI Mastery

MCP Integration

AI IDE Setup

Team Workflows

Choose Your InitRepo Journey

Web Platform Quickstart

Prerequisites

Step 1: Create Your Account

Step 2: Generate Your First Project Documentation

CLI Tool Quickstart

Prerequisites

Step 1: Install InitRepo CLI

Step 2: Analyze Your First Project

Step 3: Advanced Analysis (Optional)

MCP Server Quickstart

Prerequisites

Step 1: Install InitRepo MCP Server

Step 2: Configure Your AI Assistant

Step 3: Verify MCP Integration

Complete Integration Example

What You Get

Next Steps