Skip to content

Latest commit

 

History

History
425 lines (307 loc) · 9.49 KB

README.md

File metadata and controls

425 lines (307 loc) · 9.49 KB

@codeguide/cli

A powerful CLI tool for code guidance with programmatic API access. Get intelligent code suggestions, project management, and API key management all from your command line.

Features

  • 🔑 API Key Management: Create, manage, and revoke API keys.
  • 🤖 Codespace Tasks: Create and manage AI-powered coding tasks directly from the CLI.
  • 📝 Project Management: Initialize projects, list them, and view details.
  • 🎯 Task Management: Organize and track development tasks.
  • 🎨 Code Generation: Generate project outlines and documentation.
  • 🔍 Repository Analysis: Analyze code repositories.
  • 🔐 External Token Management: Securely store and manage external tokens (e.g., GitHub, GitLab).
  • 💳 Subscription Management: Check your current subscription status.
  • 📊 Usage Analytics: Monitor your API usage and credits.

Installation

# Install globally
npm install -g @codeguide/cli@0.0.23

# Or install locally
npm install @codeguide/cli@0.0.23

Quick Start

1. Authenticate

First, set up your API credentials. The CLI will prompt you if credentials are not found.

codeguide login

You can also set them via environment variables:

# Using database API key (recommended)
export CODEGUIDE_DATABASE_API_KEY="sk_your_database_api_key"

# Or using legacy API key + user ID
export CODEGUIDE_API_KEY="your_api_key"
export CODEGUIDE_USER_ID="your_user_id"

2. Initialize a Project

# Create a new project
codeguide init my-project

# Or initialize in current directory
codeguide init .

3. Create a Codespace Task

# Get your project ID
codeguide project list

# Create a task for the AI to work on
codeguide codespace create --project-id <your-project-id> --description "Implement user login via email and password"

Pull Project Documentation (Step-by-Step)

This guide shows you how to use codeguide pull to download all documentation for a CodeGuide project.

Prerequisites

  1. Node.js (v18 or higher)
  2. A CodeGuide account with an API key
  3. A project ID from CodeGuide (found in your project URL or dashboard)

Step 1: Install the CLI

# Install globally
npm install -g @codeguide/cli

# Verify installation
codeguide --version

Step 2: Get Your API Key

  1. Go to CodeGuide Settings
  2. Click "Create API Key"
  3. Copy your API key (starts with sk_)

Step 3: Login to CodeGuide CLI

# Login with your API key
codeguide login --api-key sk_your_api_key_here

# Or login interactively (will prompt for API key)
codeguide login

Optional: Set a custom API URL (for local development):

codeguide login --api-key sk_your_api_key --api-url http://localhost:8001

Step 4: Verify Authentication

# Check your authentication status
codeguide auth status

# Check API health
codeguide health

Step 5: Get Your Project ID

Find your project ID from:

  • CodeGuide Dashboard: Look in the URL when viewing a project (e.g., app.codeguide.dev/projects/07bf7ed7-1ced-4fa3-910b-31316a48040e)
  • CLI: Run codeguide tasks --project-id <id> if you know a partial ID

Step 6: Pull the Documentation

# Pull all documentation to ./documentation folder
codeguide pull <project-id>

# Example:
codeguide pull 07bf7ed7-1ced-4fa3-910b-31316a48040e

Step 7: Review Downloaded Files

After pulling, you'll have a documentation/ folder with:

documentation/
├── AGENTS.md                      # Project summary for AI agents
├── codeguide.json                 # Project metadata
├── project_requirements_document.md
├── tech_stack_document.md
├── app_flow_document.md
├── backend_structure_document.md
├── security_guideline_document.md
├── tasks.json                     # Task data (if available)
└── wireframes/                    # HTML wireframe files
    ├── landing_page.html
    ├── authentication.html
    └── ...

Pull Options

Option Description
-o, --output <dir> Output directory (default: ./documentation)
--cursor Generate Cursor-specific rule files (.mdc)
-v, --verbose Show detailed output
--api-url <url> Custom API URL
--api-key <key> Override saved API key

Examples

# Pull to a custom directory
codeguide pull <project-id> --output ./my-project-docs

# Pull with Cursor IDE support
codeguide pull <project-id> --cursor

# Pull with verbose logging
codeguide pull <project-id> -v

# Pull using a different API key
codeguide pull <project-id> --api-key sk_different_key

Troubleshooting

Error: "No API key provided"

# Run login first
codeguide login --api-key sk_your_key

Error: "Invalid, expired, or inactive API key"

# Check your API key at https://app.codeguide.dev/settings?tab=enhanced-api-keys
# Generate a new key if needed

Error: "Project not found"

# Verify the project ID is correct
# Make sure you have access to this project

Commands

Project Management

# Initialize a new project
codeguide init <project-name>

# Start a new project interactively
codeguide start

# List all projects
codeguide project list

# Get project details
codeguide project get <project-id>

Codespace Tasks

# Create a new codespace task
codeguide codespace create --project-id <id> --description "My new feature"

# List codespace tasks for a project
codeguide codespace list --project-id <id>

# Get details for a specific codespace task
codeguide codespace get <task-id>

Pull Project Documentation

Pull all project documentation files to your local directory.

# Pull documentation to ./documentation folder
codeguide pull <project-id>

# Pull to a custom directory
codeguide pull <project-id> --output ./my-docs

# Pull with Cursor-specific rule files
codeguide pull <project-id> --cursor

# Verbose output
codeguide pull <project-id> -v

What gets pulled:

  • Project requirement documents (PRD, tech stack, app flow, etc.)
  • Wireframes as HTML files in wireframes/ folder
  • tasks.json with task data (if available)
  • AGENTS.md with project summary
  • codeguide.json with project metadata

Task Management

# List all tasks
codeguide task list

# Start working on a task
codeguide task update <task_id> --status in_progress

# Update task progress
codeguide task update <task_id> [progress-notes]

# Mark task as completed
codeguide task update <task_id> --status completed

API Key Management

# List all API keys
codeguide api-key list

# Create a new API key
codeguide api-key create "My App Key"

# Revoke an API key
codeguide api-key revoke <key-id>

# Check API key permissions
codeguide api-key check-permission

External Token Management

# Store a new external token (e.g., for GitHub)
codeguide token store --platform github --token <ghp_token> --name "My GitHub Token"

# List all stored tokens
codeguide token list

# Revoke a stored token
codeguide token revoke <token-id>

Subscription & Usage

# Show current subscription details
codeguide subscription show

# Check usage statistics
codeguide usage stats

# Check service health
codeguide health

Authentication

# Interactive login with API key setup
codeguide login

# Direct API key authentication
codeguide login --api-key your-api-key

# Check current authentication status
codeguide auth status

# Clear stored credentials
codeguide auth logout

Configuration

Environment Variables

# Required: API endpoint
CODEGUIDE_BASE_URL="https://api.codeguide.ai"

# Authentication (choose one)
CODEGUIDE_DATABASE_API_KEY="sk_your_database_api_key"
# OR
CODEGUIDE_API_KEY="your_api_key"
CODEGUIDE_USER_ID="your_user_id"
# OR
CODEGUIDE_JWT_TOKEN="your_jwt_token"

# Optional: Timeout in milliseconds
CODEGUIDE_TIMEOUT="3600000"

Configuration File

Create a .codeguide.json file in your project root:

{
  "baseUrl": "https://api.codeguide.ai",
  "databaseApiKey": "sk_your_database_api_key",
  "timeout": 3600000
}

Authentication Methods

CodeGuide supports multiple authentication methods with the following priority:

  1. Database API Key (highest priority)

    export CODEGUIDE_DATABASE_API_KEY="sk_your_key"

  2. Legacy API Key + User ID

    export CODEGUIDE_API_KEY="your_key"
export CODEGUIDE_USER_ID="your_user_id"

  3. Clerk JWT Token (lowest priority)

    export CODEGUIDE_JWT_TOKEN="your_jwt_token"

Error Handling

CodeGuide provides detailed error messages for common issues:

Authentication Errors

❌ Authentication failed: Invalid, expired, or inactive API key

Permission Errors

❌ Access denied: Insufficient permissions or subscription required

Rate Limiting

❌ Rate limit exceeded: Too many requests. Please try again later.

Usage Limits

❌ Usage limit exceeded: Check your credit balance

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

Support

License

MIT License - see the LICENSE file for details.