A CLI tool for code guidance with programmatic API
npm install codeguideA comprehensive toolkit for AI-powered code guidance and project management. Includes both a CLI tool and a programmatic API for seamless integration into your development workflow.
A powerful CLI tool for code guidance with full project management capabilities.
Features:
- Project creation and initialization
- Task management and tracking
- API key management
- Usage analytics and monitoring
- Repository analysis
- Interactive command-line interface
Installation:
``bash`
npm install -g @codeguide/cli
The core package with TypeScript interfaces and services for integrating CodeGuide into your applications.
Features:
- Full TypeScript support with IntelliSense
- API key management (CRUD operations)
- Project management services
- Task management APIs
- Usage analytics
- Multiple authentication methods
Installation:
`bash`
npm install @codeguide/core
`bashInstall CLI
npm install -g @codeguide/cli
$3
typescript
// Install core package
npm install @codeguide/coreimport { CodeGuide } from '@codeguide/core'
const codeguide = new CodeGuide({
baseUrl: 'https://api.codeguide.ai',
databaseApiKey: 'sk_your_key'
})
// Create API key
const newKey = await codeguide.apiKeyEnhanced.createApiKey({
name: 'My Application'
})
`Documentation
| Package | Description | Link |
|---------|-------------|------|
| CLI | Command-line interface with full documentation | README |
| Core | Programmatic API with TypeScript support | README |
Commands
$3
bash
Start a new project
codeguide start [prompt] [options]Initialize current directory
codeguide initGenerate documentation
codeguide generate [options]
`$3
bash
List tasks
codeguide task list [options]Start a task
codeguide task update --status in_progressUpdate a task
codeguide task update [options]
`$3
bash
Interactive login
codeguide loginLogin with API key
codeguide login --api-key your-api-keyCheck health
codeguide healthCheck authentication status
codeguide auth status
`$3
bash
Check credit balance
codeguide usage balanceView usage summary
codeguide usage summaryCheck authorization status
codeguide usage auth
`CLI Options
$3
bash
codeguide start [prompt] [options]Options:
-l, --language Programming language
-c, --context Additional context
-v, --verbose Verbose output
-o, --output Output file (default: README.md)
--api-url API URL
--api-key API key
--current-codebase Generate in current directory
-h, --help Display help
`$3
bash
codeguide task list [options]Options:
--status Filter by status (pending, in_progress, completed)
--page Page number
--page-size Page size
codeguide task update [options]
Options:
--status Update status
--ai-result AI completion result
--title Update title<br /> --description <description> Update description<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Project Structure</h2></p><p class="my-3">When you create a new project with </code>codeguide start<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, it generates:</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />my-project/<br />āāā codeguide.json # Project configuration<br />āāā AGENTS.md # AI agent guidelines<br />āāā instructions.md # Getting started guide<br />āāā documentation/ # Generated documentation<br /> āāā project-outline.md<br /> āāā technical-specs.md<br /> āāā implementation-plan.md<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Configuration</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">- </code>CODEGUIDE_API_URL<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: API base URL (default: https://api.codeguide.dev)<br />- </code>CODEGUIDE_API_KEY<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">: API key for authentication</p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">The CLI supports multiple authentication methods:</p><p class="my-3">1. <strong>Database API Key</strong> (highest priority): </code>sk_...<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> format<br />2. <strong>Legacy API Key</strong> (medium priority): Traditional API keys<br />3. <strong>Clerk JWT Token</strong> (lowest priority): JWT tokens</p><p class="my-3">Authentication configuration is automatically saved locally for convenience.</p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">The CLI now supports interactive authentication setup:</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br /><h1 class="text-2xl font-bold mt-6 mb-4">Interactive login with API key creation</h1><br />codeguide login</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Direct API key authentication</h1><br />codeguide login --api-key your-api-key<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Development</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br /><h1 class="text-2xl font-bold mt-6 mb-4">Clone repository</h1><br />git clone https://github.com/CodeGuide-dev/codeguide.git<br />cd codeguide</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Install dependencies</h1><br />npm install</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Build all packages</h1><br />npm run build</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Link for local development</h1><br />npm run dev:link<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br /><h1 class="text-2xl font-bold mt-6 mb-4">Build all packages</h1><br />npm run build</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Build specific package</h1><br />npm run build:core<br />npm run build:cli</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Run CLI in development mode</h1><br />npm run dev</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Run tests</h1><br />npm run test</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Run tests with coverage</h1><br />npm run test:coverage</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Lint code</h1><br />npm run lint</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Type checking</h1><br />npm run typecheck</p><p class="my-3"><h1 class="text-2xl font-bold mt-6 mb-4">Format code</h1><br />npm run format<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />codeguide/<br />āāā packages/<br />ā āāā core/ # Core package (@codeguide/core)<br />ā ā āāā dist/ # Built JavaScript files<br />ā ā āāā services/ # API services<br />ā ā āāā types.ts # TypeScript types<br />ā ā āāā api-service.ts # Main API service<br />ā āāā cli/ # CLI package (@codeguide/cli)<br />ā āāā dist/ # Built JavaScript files<br />ā āāā commands.ts # CLI commands<br />ā āāā utils/ # Utility functions<br />ā āāā index.ts # CLI entry point<br />āāā package.json # Root workspace configuration<br />āāā README.md # This file<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">API Usage</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">typescript<br />import { CodeGuide } from '@codeguide/core'</p><p class="my-3">const codeguide = new CodeGuide(<br /> {<br /> baseUrl: 'https://api.codeguide.dev',<br /> databaseApiKey: 'your-api-key',<br /> },<br /> {<br /> language: 'typescript',<br /> verbose: true,<br /> }<br />)</p><p class="my-3">// Check health<br />const isHealthy = await codeguide.isHealthy()</p><p class="my-3">// Generate project title<br />const title = await codeguide.generation.generateTitle({<br /> description: 'A React app with TypeScript',<br />})</p><p class="my-3">// Generate project outline<br />const outline = await codeguide.generation.generateOutline({<br /> project_type: 'react',<br /> description: 'A React app with TypeScript',<br /> title: title.title,<br />})<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">The core package provides access to all API services:</p><p class="my-3">- <strong>Generation Service</strong>: Generate titles, outlines, and documents<br />- <strong>Projects Service</strong>: Create and manage projects<br />- <strong>Tasks Service</strong>: Task management and tracking<br />- <strong>Usage Service</strong>: Usage tracking and credit management<br />- <strong>Repository Service</strong>: Code analysis and insights</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Examples</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />codeguide start "Create a React app with TypeScript, Tailwind CSS, and routing" --language react<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />cd existing-project<br />codeguide init<br />codeguide generate --current-codebase<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />codeguide usage balance<br />codeguide usage summary --start-date 2024-01-01 --end-date 2024-12-31<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Troubleshooting</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">1. <strong>Authentication Failed</strong></p><p class="my-3"> </code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br /> # Check your API key<br /> codeguide login --api-key your-api-key</p><p class="my-3"> # Verify API health<br /> codeguide health<br /> </code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">2. <strong>Permission Denied</strong><br /> - Ensure your API key has sufficient permissions<br /> - Check your subscription status</p><p class="my-3">3. <strong>Build Errors</strong></p><p class="my-3"> </code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br /> # Clean build<br /> npm run build</p><p class="my-3"> # Check types<br /> npm run typecheck<br /> </code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">- <strong>Documentation</strong>: <a href="https://github.com/CodeGuide-dev/codeguide/wiki" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">GitHub Wiki</a><br />- <strong>Issues</strong>: <a href="https://github.com/CodeGuide-dev/codeguide/issues" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">GitHub Issues</a><br />- <strong>API Documentation</strong>: <a href="https://api.codeguide.dev/docs" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">API Docs</a></p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Contributing</h2></p><p class="my-3">1. Fork the repository<br />2. Create a feature branch<br />3. Make your changes<br />4. Add tests if applicable<br />5. Run </code>npm run dev:prepare` to lint and typecheck<br />6. Submit a pull request</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">License</h2></p><p class="my-3">MIT License - see <a href="LICENSE" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">LICENSE</a> file for details.</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Changelog</h2></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">- Bump version to 0.0.11<br />- Add --api-key flag to login command for non-interactive authentication<br />- Add interactive docs setup command with API key creation links<br />- Fix TypeScript error in cancellation funnel service</p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">- Enhanced task management system<br />- Added codespace service for development environments<br />- Improved error handling and type safety</p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">- Initial release<br />- Project creation with AI-generated documentation<br />- Task management system<br />- Authentication and usage tracking<br />- CLI and programmatic API interfaces<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:3"></template><template id="P:4"></template></div></div></div><script>self.__next_f.push([1,"28:[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}]\n29:[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^1.22.0\"}]\n2a:[\"$\",\"$L5\",\"jest\",{\"href\":\"/package/jest\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"jest\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^29.0.0\"}]]}]\n2b:[\"$\",\"$L5\",\"prettier\",{\"href\":\"/package/prettier\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"prettier\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^3.0.0\"}]]}]\n2c:[\"$\",\"$L5\",\"ts-jest\",{\"href\":\"/package/ts-jest\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"ts-jest\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^29.0.0\"}]]}]\n2d:[\"$\",\"$L5\",\"ts-node\",{\"href\":\"/package/ts-node\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"ts-node\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^10.9.0\"}]]}]\n2e:[\"$\",\"$L5\",\"typescript\",{\"href\":\"/package/typescript\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hove"])</script><script>self.__next_f.push([1,"r:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"typescript\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^5.0.0\"}]]}]\n"])</script><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><script>$RC("B:1","S:1")</script></body></html>