Dreamly 🌖

Dreamly is an AI Agent Platform with seamless Claude Code integration, providing a powerful web-based interface for AI assistance and automation.

Installation

Global Installation

Install Dreamly globally using npm:

npm install -g dreamly

Local Installation

You can also install it locally in your project:

npm install dreamly

Quick Start

After installation, start Dreamly server:

dreamly

This will start the Dreamly server with default settings (typically on port 3001).

Command Line Options

dreamly [options]

Options:
  --port <number>     Port number (default: 3001)
  --host <string>     Host address (default: localhost)
  --token <string>    Authentication token
  --skip-auth-token   Skip authentication token requirement
  --help              Show help

Examples

# Start on custom port
dreamly --port 8080

# Start with custom host
dreamly --host 0.0.0.0 --port 3001

# Start without authentication
dreamly --skip-auth-token

Features

• 🤖 Claude Code Integration - Seamless integration with Anthropic's Claude Code
• 🌐 Web Interface - Modern, responsive web UI for AI interactions
• 🔧 MCP Support - Model Context Protocol for enhanced capabilities
• 🔐 Secure - Built-in authentication and permission management
• 📱 Mobile Support - QR code authentication for mobile access
• 🔔 Notifications - Real-time notifications for important events
• 🎯 Agent Platform - Create and manage custom AI agents

Development

Prerequisites

• Node.js >= 20.19.0
• npm or yarn

Local Development

1. Clone the repository:

git clone https://github.com/mengshengwei/dreamly.git
cd dreamly

2. Install dependencies:

npm install

3. Start development server:

npm run dev

4. Build for production:

npm run build

Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run start - Start production server
• npm test - Run tests
• npm run lint - Run linter
• npm run typecheck - Run type checking

Configuration

Dreamly can be configured through:

• Command line arguments
• Environment variables
• Configuration files in ~/.dreamly/ directory

Claude Code Router (CCR) Integration

Dreamly now integrates with Claude Code Router (CCR) to provide enhanced model routing and API management capabilities. During installation, CCR is automatically configured with Dreamly's default settings.

Automatic Setup: When you install Dreamly, the postinstall script will:

1. Install Claude Code Router globally (if not already installed)
2. Configure CCR with Dreamly's default provider settings
3. Set up the CCR configuration at ~/.claude-code-router/config.json

Default Configuration: The default CCR configuration uses Dreamly's API endpoint with the following settings:

• Provider: dreamy
• API Base URL: https://fkyrxaimefqr.sealosbja.site/v1/chat/completions
• Default Model: anthropic/claude-sonnet-4
• Router strategy: Uses Dreamy provider for all routing scenarios (default, background, think, longContext, webSearch)

Custom Configuration: You can customize the CCR configuration by:

1. Editing ~/.claude-code-router/config.json directly
2. Adding additional providers
3. Modifying router strategies
4. Setting custom API keys

After making changes to the CCR config, restart the CCR service:

ccr restart

How it Works:

• Dreamly automatically detects if CCR is installed and uses it to launch Claude Code
• If CCR is available, commands are routed through ccr code instead of direct claude CLI
• If CCR is not found, Dreamly falls back to using the standard Claude CLI

For more information about Claude Code Router configuration options, visit the CCR GitHub repository.

FRP Tunnel Configuration

Dreamly supports built-in FRP (Fast Reverse Proxy) tunnel to expose your local server to the internet. To enable it, add the following configuration to your ~/.dreamly/config.json:

{
  "frpc": {
    "enabled": true,
    "serverAddr": "101.201.82.35",
    "serverPort": 8888,
    "proxies": [
      {
        "name": "dreamly",
        "type": "tcp",
        "localIp": "127.0.0.1",
        "localPort": 8883,
        "remotePort": 5000
      }
    ]
  }
}

Configuration options:

• enabled: Enable/disable the FRP tunnel (default: false)
• serverAddr: FRP server address
• serverPort: FRP server port
• proxies: Array of proxy configurations
  • name: Unique name for the proxy
  • type: Proxy type (tcp, udp, http, https)
  • localIp: Local IP address (usually 127.0.0.1)
  • localPort: Local port to forward (your Dreamly server port)
  • remotePort: Remote port on the FRP server (for tcp/udp)
  • customDomains: Custom domains (for http/https)

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

Support

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📧 Email: Contact the maintainer

Acknowledgments

• Built with Claude Code
• Powered by Anthropic's Claude AI
• UI components from Radix UI
• Styling with Tailwind CSS