raycast-cli

# Raycast CLI Guide

Raycast is a productivity platform that allows developers to build custom extensions using TypeScript and React. This guide provides essential workflows and quick references for creating and publishing Raycast extensions.

## Quick Start

```bash
# Check prerequisites
node --version          # Required: Node.js 22.14+
open -a Raycast        # Required: Raycast 1.26.0+

# Create extension via Raycast
# Open Raycast → Type "Create Extension"

# Install dependencies
pnpm install

# Start development
pnpm dev

# Test in Raycast
# Open Raycast (Cmd + Space)
# Extension appears at top of search
```

## Common Workflows

### Workflow 1: Create New Extension

```bash
# Create extension via Raycast
# Open Raycast → Type "Create Extension"
# Choose template or start from scratch

# Navigate to extension directory
cd ~/Developer/my-extension

# Install dependencies
pnpm install

# Start development
pnpm dev

# Open Raycast to test
# Extension appears at top of root search
```

### Workflow 2: Development with Hot Reload

```bash
# Start development mode
pnpm dev

# Edit files in src/ directory
# Changes reflect immediately in Raycast
# View logs in terminal
# View errors in Raycast overlay

# Toggle hot reload if needed
# Raycast → Preferences → Extensions → Development
# "Auto-reload on file changes"
```

### Workflow 3: Build and Publish Extension

```bash
# Run linter
pnpm lint

# Build for production
pnpm build

# Add README and screenshots
cat > README.md << 'EOF'
# Extension Name
Description and usage
EOF

# Add screenshots to assets/
# Take screenshots of each command

# Publish to Raycast Store
pnpm publish

# For public extensions:
# - Authenticates with GitHub
# - Creates PR in raycast/extensions repo
# - Awaits team review
```

### Workflow 4: API Integration

```bash
# Add API preferences to package.json
# Configure authentication in preferences

# Start development
pnpm dev

# Test API integration
# View logs in terminal
# Handle errors with s