OnboardGPT CLI for repository analysis and onboarding
npm install @harshalgdevs/onboardgptAI-powered repository analysis and onboarding assistant. Generate intelligent summaries, analyze dependencies, detect entry points, and understand tech stacks with a single command.
``bashInstall dependencies
npm install
๐ 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
- --verbose: Enable detailed error information
- --help: Show usage information
- --version: Display version number๐ Usage Examples
$3
`bash
Full analysis with all features
node index.jsAnalyze specific repository
node index.js /path/to/my-project
`$3
`bash
Skip dependency analysis (faster for large projects)
node index.js --no-depsOnly analyze tech stack
node index.js --no-deps --no-entryMinimal analysis
node index.js --no-deps --no-entry --no-stack
`$3
`bash
Developer-focused summary with code examples
node index.js --summarize developerPM summary focusing on business impact
node index.js --summarize pmNew hire onboarding with setup instructions
node index.js --summarize new-hireSecurity and compliance focused
node index.js --summarize auditor
`$3
`bash
JSON output for automated processing
node index.js --output jsonSelective analysis with JSON output
node index.js --no-deps --output jsonSummary in JSON format
node index.js --summarize developer --output json
`$3
`bash
Skip deps, generate PM summary, output as JSON
node index.js --no-deps --summarize pm --output jsonFast analysis with new-hire summary
node index.js --no-deps --no-entry --summarize new-hireFull 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
$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, auditorInvalid output format
โ Error: Invalid output format: xml. Must be one of: text, jsonNon-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 Ready for Sprint 2: VS Code Extension Polish (Days 5-8):
- User settings integration
- UI improvements with collapsible sections
- Live streaming progress indicators