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

``bash

`Install globally (recommended)`


npm install -g onboardgpt
Or run without installing

npx onboard-gpt --help
Analyze current directory

onboard-gpt
Analyze specific repository

onboard-gpt /path/to/repository
Generate summary for developers

onboard-gpt --summarize developer
JSON output for CI/CD

onboard-gpt --output json


📋 Features
$3

-

--no-deps

: Skip dependency analysis
-

--no-entry

: Skip entry point detection
-

--no-stack

: Skip technology stack analysis
$3

-

--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
$3

-

--output text

: Human-readable format (default)
-

--output json

: Machine-readable JSON for CI/CD integration
$3

-

--agent

: Enable advanced AI-powered code analysis
-

--interactive

: Start conversational repository exploration
-

--agent-max-files

: Control analysis scope (default: 50)
-

--agent-max-depth

: Control directory depth (default: 5)
$3

-

--verbose

: Enable detailed error information
-

--help

: Show usage information
-

--version

: Display version number
📖 Usage Examples
$3

bash
Full analysis with all features

onboard-gpt
Analyze specific repository

onboard-gpt /path/to/my-project

$3

bash
Skip dependency analysis (faster for large projects)

onboard-gpt --no-deps
Only analyze tech stack

onboard-gpt --no-deps --no-entry
Minimal analysis

onboard-gpt --no-deps --no-entry --no-stack

$3

bash
Developer-focused summary with code examples

onboard-gpt --summarize developer
PM summary focusing on business impact

onboard-gpt --summarize pm
New hire onboarding with setup instructions

onboard-gpt --summarize new-hire
Security and compliance focused

onboard-gpt --summarize auditor

$3

bash
JSON output for automated processing

onboard-gpt --output json
Selective analysis with JSON output

onboard-gpt --no-deps --output json
Summary in JSON format

onboard-gpt --summarize developer --output json

$3

bash
Enable AI agent for intelligent code analysis

onboard-gpt --agent
Start interactive AI exploration session

onboard-gpt --agent --interactive
Configure agent analysis scope

onboard-gpt --agent --agent-max-files 100 --agent-max-depth 5
Combine agent with traditional analysis

onboard-gpt --agent --summarize developer

$3

bash
Skip deps, generate PM summary, output as JSON

onboard-gpt --no-deps --summarize pm --output json
Fast analysis with new-hire summary

onboard-gpt --no-deps --no-entry --summarize new-hire
Full analysis with developer summary

onboard-gpt --summarize developer --verbose
AI agent with selective analysis

onboard-gpt --agent --no-deps --interactive


🔧 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
$3


🚀 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...`

`$3`

json
{
  "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:

`bash

`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:

`bash 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:

`yaml

`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