Package Exports

onboardgpt
onboardgpt/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (onboardgpt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OnboardGPT CLI

AI-powered repository analysis and onboarding assistant. Generate intelligent summaries, analyze dependencies, detect entry points, and understand tech stacks with a single command.

🚀 Quick Start

# Install dependencies
npm install

# Analyze current directory
node index.js

# Analyze specific repository
node index.js /path/to/repository

# Generate summary for developers
node index.js --summarize developer

# Output as JSON for CI/CD
node index.js --output json

📋 Features

🔍 Selective Analysis

--no-deps: Skip dependency analysis
--no-entry: Skip entry point detection
--no-stack: Skip technology stack analysis

🤖 AI-Powered Summaries

--summarize developer: Technical summary for developers
--summarize pm: Product manager focused summary
--summarize new-hire: Onboarding guide for new team members
--summarize auditor: Compliance and security focused summary

📤 Output Formats

--output text: Human-readable format (default)
--output json: Machine-readable JSON for CI/CD integration

🛠️ Additional Options

--verbose: Enable detailed error information
--help: Show usage information
--version: Display version number

📖 Usage Examples

Basic Analysis

# Full analysis with all features
node index.js

# Analyze specific repository
node index.js /path/to/my-project

Selective Analysis

# Skip dependency analysis (faster for large projects)
node index.js --no-deps

# Only analyze tech stack
node index.js --no-deps --no-entry

# Minimal analysis
node index.js --no-deps --no-entry --no-stack

AI-Powered Summaries

# Developer-focused summary with code examples
node index.js --summarize developer

# PM summary focusing on business impact
node index.js --summarize pm

# New hire onboarding with setup instructions
node index.js --summarize new-hire

# Security and compliance focused
node index.js --summarize auditor

CI/CD Integration

# JSON output for automated processing
node index.js --output json

# Selective analysis with JSON output
node index.js --no-deps --output json

# Summary in JSON format
node index.js --summarize developer --output json

Complex Combinations

# Skip deps, generate PM summary, output as JSON
node index.js --no-deps --summarize pm --output json

# Fast analysis with new-hire summary
node index.js --no-deps --no-entry --summarize new-hire

# Full analysis with developer summary
node index.js --summarize developer --verbose

🔧 Configuration

The CLI automatically detects and analyzes:

Dependencies: package-lock.json, yarn.lock, Pipfile.lock, poetry.lock
Entry Points: Main scripts, web applications, CLI tools, libraries
Tech Stacks: Languages and framework versions
Project Structure: Key files and directories

📊 Output Examples

Text Output (Default)

🚀 OnboardGPT Analysis
📁 Repository: /path/to/project
⚙️ Config: deps=true, entry=true, stack=true

📊 OVERVIEW
- Total Files: 1,245
- Languages: TypeScript, JavaScript, Python
- Dependencies: 127 (45 dev)

📦 DEPENDENCIES
- Production: 82
- Development: 45
- Total: 127

🚀 ENTRY POINTS
🌐 Web Applications:
  - src/app.js (Express server)
  - src/client/index.tsx (React app)

📝 SUMMARY
Generated AI summary based on audience...

JSON Output

{
  "overview": {
    "totalFiles": 1245,
    "languages": ["TypeScript", "JavaScript", "Python"],
    "keyDirectories": ["src", "tests", "docs"]
  },
  "dependencies": {
    "total": 127,
    "direct": 23,
    "dev": 45,
    "tree": [...]
  },
  "entryPoints": [...],
  "techStacks": [...],
  "summary": "AI-generated summary..."
}

🚦 Error Handling

The CLI provides helpful error messages:

# Invalid audience
❌ Error: Invalid audience: invalid. Must be one of: developer, pm, new-hire, auditor

# Invalid output format  
❌ Error: Invalid output format: xml. Must be one of: text, json

# Non-existent repository
❌ Error: Repository path does not exist: /invalid/path

🧪 Testing

Run the comprehensive test suite:

npm test

Test Coverage: 28 tests covering all functionality:

✅ Basic CLI operations
✅ Selective analyzer flags
✅ Summary generation
✅ Output formats
✅ Error handling
✅ Complex flag combinations

🔄 CI/CD Integration

Perfect for automated workflows:

# GitHub Actions example
- name: Analyze Repository
  run: |
    npx onboard-gpt --output json > analysis.json
    
- name: Generate Documentation
  run: |
    npx onboard-gpt --summarize developer > ONBOARDING.md

🎯 Success Criteria (Day 4 Complete)

✅ Selective Analyzer Flags: --no-deps, --no-entry, --no-stack all working
✅ Summary Controls: All audiences (developer, pm, new-hire, auditor) implemented
✅ Output Formats: Both text and JSON formats working perfectly
✅ Flag Combinations: All combinations tested and working
✅ Error Handling: Comprehensive validation and user-friendly error messages
✅ Unit Tests: 28/28 tests passing with ≥90% coverage
✅ Integration Demo: Full functionality demonstrated end-to-end

🚀 Next Steps

Ready for Sprint 2: VS Code Extension Polish (Days 5-8):

User settings integration
UI improvements with collapsible sections
Live streaming progress indicators