Happy Coder

https://happy.engineering/docs
Admin
Happy Coder is a free, open-source platform that lets you control Claude Code AI coding agents...
Tokens:17,868
Snippets:237
Trust Score:7.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Happy CLI

Source: https://happy.engineering/docs/quick-start

Installs the Happy CLI globally using npm.

```bash
npm install -g happy
```

--------------------------------

### Show QR Code for Authentication

Source: https://happy.engineering/docs/quick-start

Displays a QR code for authenticating the mobile app with the computer.

```bash
happy --auth # Shows QR code
```

--------------------------------

### Production Setup with HTTPS

Source: https://happy.engineering/docs/guides/self-hosting

Install Caddy and configure it as a reverse proxy for HTTPS.

```bash
# Install Caddy (auto-manages SSL certificates)
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy
 
# Configure reverse proxy
sudo tee /etc/caddy/Caddyfile <<EOF
your-domain.com {
    reverse_proxy localhost:3000
}
EOF
 
# Start Caddy
sudo systemctl restart caddy
```

--------------------------------

### Git Worktree Setup

Source: https://happy.engineering/docs/guides/happy-coder-best-practices

Example commands to create multiple git worktrees for parallel experimentation.

```bash
# Create a few worktrees for experiments
git worktree add ../project-experiment-1 -b experiment-1
git worktree add ../project-experiment-2 -b experiment-2
git worktree add ../project-experiment-3 -b experiment-3
```

--------------------------------

### Docker Compose Setup

Source: https://happy.engineering/docs/guides/self-hosting

Example docker-compose.yml file for setting up Happy Server with PostgreSQL and Redis.

```yaml
version: '3.8'
services:
  happy-server:
    image: happy-server:latest
    ports:
      - "3000:3000"
    restart: unless-stopped
    environment:
      - NODE_ENV=production
      - DATABASE_URL=postgresql://postgres:postgres@localhost:5432/happy-server
      - REDIS_URL=redis://localhost:6379
      - SEED=your-seed-for-token-generation
      - PORT=3005
    depends_on:
      - postgres
      - redis
 
  postgres:
    image: postgres:15
    environment:
      - POSTGRES_DB=happy-server
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    volumes:
      - postgres_data:/var/lib/postgresql/data
    ports:
      - "5432:5432"
 
  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"
    volumes:
      - redis_data:/data 

volumes:
  postgres_data:
  redis_data:
```

--------------------------------

### Install and verify Claude Code

Source: https://happy.engineering/docs/faq

Instructions to install Claude Code globally using npm and verify the installation.

```bash
npm install -g claude-code
claude-code --version  # Verify installation
happy  # Now this should work
```

--------------------------------

### Use Claude app for desktop

Source: https://happy.engineering/docs/faq

Example terminal command to interact with Claude Code from the desktop.

```bash
claude-code "help me fix this bug"
```

--------------------------------

### Install Claude Code CLI

Source: https://happy.engineering/docs/faq

This command installs the Claude Code desktop CLI globally using npm.

```bash
npm install -g claude-code
```

--------------------------------

### Installation Command

Source: https://happy.engineering/docs/distribution

Command to install and run the Happy Coder application.

```bash
npm i -g happy && happy
```

--------------------------------

### Kubernetes Secrets Configuration

Source: https://happy.engineering/docs/guides/self-hosting

Example secret file for environment variables in Kubernetes.

```yaml
# happy-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: happy-secrets
type: Opaque
stringData:
  DATABASE_URL: "postgresql://postgres:postgres@postgres-service:5432/happy-server"
  REDIS_URL: "redis://redis-service:6379"
  SEED: "your-secure-seed-for-token-generation"
  PORT: "3005"
  NODE_ENV: "production"

```

--------------------------------

### Personal Agent Configuration

Source: https://happy.engineering/docs/use-cases/hemingway-technique

This is an example configuration for a personal agent named 'bedtime' that can be added to the ~/.claude/agents directory. It includes a name, description, examples of usage, available tools, model, and color.

```yaml
---
name: bedtime
description: Use this agent when you want to quickly review Linear issues before bed to find simple, actionable coding tasks that can be worked on overnight. This agent helps you identify issues that are straightforward enough to tackle without major architectural decisions or product discussions, perfect for a 10-minute pre-sleep workflow to replace social media scrolling.\n\nExamples:\n- <example>\n  Context: User wants to find a simple issue to work on before going to sleep.\n  user: "I'm heading to bed, let me find something to work on"\n  assistant: "I'll use the bedtime agent to search through Linear issues and find you something suitable to work on tonight."
  <commentary>\n  The user is preparing for their bedtime routine and wants to find a simple coding task, so we use the bedtime agent to search Linear and present suitable options.
  </commentary>
</example>\n- <example>\n  Context: User explicitly calls the bedtime agent.\n  user: "/bedtime"\n  assistant: "Let me launch the bedtime agent to find you a good issue for tonight's coding session."
  <commentary>\n  The user has directly invoked the bedtime command, so we use the bedtime agent to search for appropriate issues.
  </commentary>
</example>
tools: Glob, Grep, LS, Read, Edit, MultiEdit, Write, WebFetch, TodoWrite, WebSearch, BashOutput, KillBash, mcp__linear-server__list_comments, mcp__linear-server__create_comment, mcp__linear-server__get_document, mcp__linear-server__list_documents, mcp__linear-server__get_issue, mcp__linear-server__list_issues, mcp__linear-server__create_issue, mcp__linear-server__update_issue, mcp__linear-server__list_issue_statuses, mcp__linear-server__get_issue_status, mcp__linear-server__list_my_issues, mcp__linear-server__list_issue_labels, mcp__linear-server__create_issue_label, mcp__linear-server__list_projects, mcp__linear-server__get_project, mcp__linear-server__create_project, mcp__linear-server__update_project, mcp__linear-server__list_project_labels, mcp__linear-server__list_teams, mcp__linear-server__get_team, mcp__linear-server__list_users, mcp__linear-server__get_user, mcp__linear-server__search_documentation, Bash
model: opus
color: pink
---
 
You are a friendly, efficient issue analyst specializing in identifying simple, actionable coding tasks perfect for focused evening work sessions. Your role is to help developers quickly find meaningful work that can be completed overnight without requiring complex decisions or discussions. 
 
You have access to Linear MCP tools and will use them to search through issues and present the most suitable options for a pre-sleep coding session. 
 
**Your Mission:**
1. Search Linear for open issues using the available MCP tools
2. Filter and evaluate issues based on complexity and scope
3. Present 1-3 ideal candidates with clear, concise pitches
4. Highlight any missing information needed from the user
5. Provide a confidence assessment for overnight completion
 
**Issue Selection Criteria:**

```

--------------------------------

### Launch Happy daemon

Source: https://happy.engineering/docs/faq

Command to launch the Happy daemon.

```bash

```

--------------------------------

### Run the Server

Source: https://happy.engineering/docs/guides/self-hosting

Run the Happy Server using Docker, configuring essential environment variables.

```bash
docker run -d \
  --name happy-server \
  -p 3000:3000 \
  -e NODE_ENV=production \
  -e DATABASE_URL="postgresql://postgres:postgres@localhost:5432/happy-server" \
  -e REDIS_URL="redis://localhost:6379" \
  -e SEED="your-seed-for-token-generation" \
  -e PORT=3005 \
  --restart unless-stopped \
  happy-server:latest
```

--------------------------------

### Configure Your Devices

Source: https://happy.engineering/docs/guides/self-hosting

Configure your phone and computer to use your self-hosted Happy Server.

```bash
export HAPPY_SERVER_URL="http://your-server:3000"
# Configure your CLI to use your server
```

--------------------------------

### Clone and Build

Source: https://happy.engineering/docs/guides/self-hosting

Clone the repository and build the Docker image for the Happy Server.

```bash
# Get the code
git clone https://github.com/slopus/happy-server
cd happy-server
 
# Build with Docker
docker build -t happy-server:latest .
```

--------------------------------

### Backup Your Data

Source: https://happy.engineering/docs/guides/self-hosting

Commands for backing up the encrypted data stored by the Happy Server.

```bash
# Simple backup
tar -czf backup-$(date +%Y%m%d).tar.gz ./data
 
# Or sync to another location
rsync -av ./data/ backup-location/
```

--------------------------------

### Monitor Your Server

Source: https://happy.engineering/docs/guides/self-hosting

Commands to monitor the Happy Server's health and statistics.

```bash
# View logs
docker logs -f happy-server
 
# Check health endpoint
curl http://your-server:3000/health
 
# See connection count  
curl http://your-server:3000/stats
```

--------------------------------

### Running Happy Coder on Laptop

Source: https://happy.engineering/docs/features/real-time-sync

This command initiates the real-time synchronization by wrapping Claude Code and establishing a connection to the mobile device.

```bash
happy
```

--------------------------------

### Apply Kubernetes Secret

Source: https://happy.engineering/docs/guides/self-hosting

Command to apply the Kubernetes secret file.

```shell
kubectl apply -f happy-secrets.yaml

```

--------------------------------

### Send a Test Push Notification

Source: https://happy.engineering/docs/guides/push-notifications

Use the Happy CLI to send a test push notification with a message and title.

```bash
happy notify -p "message of push notification" -t "Title of Notification"
```

--------------------------------

### Adjust QR code size or use manual code

Source: https://happy.engineering/docs/faq

Command-line options to adjust the QR code size or disable QR codes in favor of manual input.

```bash
happy --qr-size large
happy --no-qr
```

--------------------------------

### Kubernetes Deployment Configuration

Source: https://happy.engineering/docs/guides/self-hosting

Production configuration for deploying Happy Server on Kubernetes.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: happy-server
spec:
  strategy:
    type: RollingUpdate
    rollingUpdate:
      maxUnavailable: 0
      maxSurge: 1
  replicas: 1
  selector:
    matchLabels:
      app: happy-server
  template:
    metadata:
      labels:
        app: happy-server
    spec:
      containers:
      - name: happy-server
        image: happy-server:latest  # Use your actual image registry
        ports:
        - containerPort: 3005
        envFrom:
        - secretRef:
            name: happy-secrets
---
apiVersion: policy/v1
kind: PodDisruptionBudget
metadata:
  name: happy-server-pdb
spec:
  minAvailable: 1
  selector:
    matchLabels:
      app: happy-server
 
---
apiVersion: v1
kind: Service
metadata:
  name: happy-server
spec:
  selector:
    app: happy-server
  ports:
  - port: 3005
    targetPort: 3005
  type: ClusterIP

```

--------------------------------

### Troubleshoot 'Port already in use' error

Source: https://happy.engineering/docs/faq

Commands to find and kill the process using a specific port, or to run Happy Coder on a different port.

```bash
# Find what's using the port
lsof -i :8765
 
# Kill it
kill -9 [PID]
 
# Or use a different port
happy --port 8766
```

--------------------------------

### Full Description

Source: https://happy.engineering/docs/distribution

A comprehensive description for platforms that allow extensive text.

```text
The most popular mobile app for Claude Code & Codex on the App Store. Spawn and control multiple Claude Codes in parallel from your phone and desktop. Happy Coder runs coding agents on your hardware, works from your phone and desktop, and costs nothing.

Features:
- Hands-free control with voice agent—not just dictation
- Multiple active sessions across multiple machines
- Works seamlessly with your existing tools and workflow
- Secure with end-to-end encryption
- Open source (MIT licensed)
```

--------------------------------

### Short Description

Source: https://happy.engineering/docs/distribution

A brief description for platforms requiring a short text.

```text
The most popular mobile app for Claude Code & Codex on the App Store. Launch, monitor, and steer Claude Code & Codex in parallel from your phone. Happy Coder runs on your hardware, costs nothing. Open source.
```

--------------------------------

### Feature List

Source: https://happy.engineering/docs/distribution

A bulleted list of key features for promotional materials.

```text
- Hands-free control with voice agent—not just dictation
- Multiple active sessions across multiple machines
- Works seamlessly with your existing tools and workflow
- Secure with end-to-end encryption
- Open source (MIT licensed)
```
Tokens:
Raw