Xingshu

Code on the go — control AI coding agents from your mobile device.

Free. Open source. Code anywhere.

Installation

npm install -g xingshu-coder

Usage

Claude (default)

xingshu

yarn dev:local-server -- auth logout

This will:

1. Start a Claude Code session
2. Display a QR code to connect from your mobile device
3. Allow real-time session sharing between Claude Code and your mobile app

Gemini

xingshu gemini

Start a Gemini CLI session with remote control capabilities.

First time setup:

# Authenticate with Google
xingshu connect gemini

Commands

• xingshu auth – Manage authentication
• xingshu codex – Start Codex mode
• xingshu connect – Store AI vendor API keys in Xingshu cloud
• xingshu notify – Send a push notification to your devices
• xingshu daemon – Manage background service
• xingshu doctor – System diagnostics & troubleshooting

Main Commands

• xingshu – Start Claude Code session (default)
• xingshu gemini – Start Gemini CLI session
• xingshu codex – Start Codex mode

Utility Commands

• xingshu auth – Manage authentication
• xingshu connect – Store AI vendor API keys in Happy cloud
• xingshu notify – Send a push notification to your devices
• xingshu daemon – Manage background service
• xingshu doctor – System diagnostics & troubleshooting

Connect Subcommands

xingshu connect gemini     # Authenticate with Google for Gemini
xingshu connect claude     # Authenticate with Anthropic
xingshu connect codex      # Authenticate with OpenAI
xingshu connect status     # Show connection status for all vendors

Gemini Subcommands

xingshu gemini                      # Start Gemini session
xingshu gemini model set <model>    # Set default model
xingshu gemini model get            # Show current model
xingshu gemini project set <id>     # Set Google Cloud Project ID (for Workspace accounts)
xingshu gemini project get          # Show current Google Cloud Project ID

Available models: gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite

Options

Claude Options

• -m, --model <model> - Claude model to use (default: sonnet)
• -p, --permission-mode <mode> - Permission mode: auto, default, or plan
• --claude-env KEY=VALUE - Set environment variable for Claude Code
• --claude-arg ARG - Pass additional argument to Claude CLI

Global Options

• -h, --help - Show help
• -v, --version - Show version

Environment Variables

Happy Configuration

• XINGSHU_SERVER_URL - Custom server URL (default: https://api.cluster-fluster.com)
• XINGSHU_WEBAPP_URL - Custom web app URL (default: https://app.happy.engineering)
• XINGSHU_HOME_DIR - Custom home directory for Happy data (default: ~/.xingshuzc)
• XINGSHU_DISABLE_CAFFEINATE - Disable macOS sleep prevention (set to true, 1, or yes)
• XINGSHU_EXPERIMENTAL - Enable experimental features (set to true, 1, or yes)

Gemini Configuration

• GEMINI_MODEL - Override default Gemini model
• GOOGLE_CLOUD_PROJECT - Google Cloud Project ID (required for Workspace accounts)

Gemini Authentication

Personal Google Account

Personal Gmail accounts work out of the box:

xingshu connect gemini
xingshu gemini

Google Workspace Account

Google Workspace (organization) accounts require a Google Cloud Project:

1. Create a project in Google Cloud Console
2. Enable the Gemini API
3. Set the project ID:

xingshu gemini project set your-project-id

Or use environment variable:

GOOGLE_CLOUD_PROJECT=your-project-id xingshu gemini

Guide: https://goo.gle/gemini-cli-auth-docs#workspace-gca

Contributing

Interested in contributing? See CONTRIBUTING.md for development setup and guidelines.

Requirements

• Node.js >= 20.0.0

For Claude

• Claude CLI installed & logged in (claude command available in PATH)

For Gemini

• Gemini CLI installed (npm install -g @google/gemini-cli)
• Google account authenticated via xingshu connect gemini

License

MIT