GuideAI CLI

AI-powered developer tooling and task orchestration.

Installation

npm install -g @sandrisesf/guideai

This npm package is a wrapper that manages the Python-based GuideAI CLI. Python 3.10+ is required and will be detected automatically.

Prerequisites

• Node.js 18+ (for the npm wrapper)
• Python 3.10+ (for GuideAI itself)

The wrapper will automatically install the Python package on first use if not already present.

Usage

# Initialize a new project
guideai init

# Check installation health
guideai doctor

# Start the MCP server for VS Code/Cursor integration
guideai mcp-server

# Show help
guideai --help

VS Code / Cursor Integration

Add to your VS Code settings.json:

{
  "github.copilot.chat.mcpServers": {
    "guideai": {
      "command": "guideai",
      "args": ["mcp-server"]
    }
  }
}

Alternative Installation Methods

pip (Python)

pip install guideai

Homebrew (macOS)

Requires a published tap repository (for example SandRiseStudio/homebrew-guideai; see packages/homebrew/README.md).

brew tap sandrisestudio/guideai
brew install guideai

Configuration

Configuration is stored in YAML format:

• ~/.guideai/config.yaml - User-level configuration
• .guideai/config.yaml - Project-level configuration

Run guideai init to create a configuration file interactively.

Links

• Documentation
• GitHub
• PyPI

License

Apache-2.0