mirror of
https://github.com/wu736139669/hapi.git
synced 2026-08-05 06:24:37 +00:00
weishu
90cb7dae05
- Update CI workflow to package release artifacts with correct naming (hapi-* prefix) - Generate SHA256 checksums for all artifacts - Auto-update homebrew-tap repository on release - Add Installation section to README with Homebrew, npm, and binary options - Simplify .release-it.json config as CI now handles release process - Add update-homebrew-formula script to update formula in homebrew-tap - Add release-artifacts directory to .gitignore Users can now install via: brew install tiann/tap/hapi
129 lines
2.7 KiB
Markdown
129 lines
2.7 KiB
Markdown
# hapi
|
|
|
|
HAPI means "哈皮," a Chinese transliteration of [happy](https://github.com/slopus/happy), great credit to the original Happy project.
|
|
|
|
Run Claude Code / Codex / Gemini sessions locally and control them remotely through a Web / PWA / Telegram Mini App.
|
|
|
|
## Features
|
|
|
|
- Start AI coding sessions from any machine.
|
|
- Monitor and control sessions from your phone or browser.
|
|
- Approve or deny tool permissions remotely.
|
|
- Browse files and view git diffs.
|
|
- Track session progress with todo lists.
|
|
- Supports multiple AI backends: Claude Code, Codex, and Gemini.
|
|
|
|
## Installation
|
|
|
|
### Homebrew (macOS/Linux)
|
|
|
|
```bash
|
|
brew install tiann/tap/hapi
|
|
```
|
|
|
|
### npm/npx
|
|
|
|
```bash
|
|
npx @twsxtd/hapi
|
|
```
|
|
|
|
Or install globally:
|
|
|
|
```bash
|
|
npm install -g @twsxtd/hapi
|
|
```
|
|
|
|
### Prebuilt binary
|
|
|
|
Download from [Releases](https://github.com/tiann/hapi/releases).
|
|
|
|
## Quickstart
|
|
|
|
1. Start the server on a machine you control:
|
|
|
|
```bash
|
|
hapi server
|
|
# or: npx @twsxtd/hapi server
|
|
```
|
|
|
|
2. If the server has no public IP, expose it over HTTPS:
|
|
- Cloudflare Tunnel: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/
|
|
- Tailscale: https://tailscale.com/kb/
|
|
|
|
3. Run the CLI on the machine where you want sessions:
|
|
|
|
```bash
|
|
# If the server is not on localhost:3006
|
|
export HAPI_SERVER_URL="https://your-domain.example"
|
|
|
|
hapi
|
|
# or: npx @twsxtd/hapi
|
|
```
|
|
|
|
4. Open the UI in a browser at the server URL and log in with `CLI_API_TOKEN`.
|
|
|
|
## Telegram Mini App (optional)
|
|
|
|
To use Telegram for notifications and the Mini App:
|
|
|
|
1. Create a bot with @BotFather and get the token.
|
|
|
|
2. Expose your server over HTTPS (Cloudflare Tunnel, Tailscale, etc.).
|
|
|
|
3. Add environment variables:
|
|
|
|
```
|
|
WEBAPP_URL="https://your-domain.example"
|
|
TELEGRAM_BOT_TOKEN="..."
|
|
```
|
|
|
|
4. Start the server and send `/start` to the bot to get your chat ID.
|
|
|
|
5. Add your chat ID and restart:
|
|
|
|
```
|
|
ALLOWED_CHAT_IDS="12345678"
|
|
```
|
|
|
|
6. Run `/app` in the bot chat to open the Mini App.
|
|
|
|
## Multi-agent support
|
|
|
|
- `hapi` - Start a Claude Code session.
|
|
- `hapi codex` - Start an OpenAI Codex session.
|
|
- `hapi gemini` - Start a Google Gemini session.
|
|
|
|
## CLI config file
|
|
|
|
You can store the token in `~/.hapi/settings.json` instead of an env var.
|
|
Environment variables take priority over the file.
|
|
|
|
## Requirements
|
|
|
|
- Claude CLI installed and logged in (`claude` on PATH) for Claude Code sessions.
|
|
- Bun if building from source.
|
|
|
|
## Build from source
|
|
|
|
```bash
|
|
bun install
|
|
bun run build
|
|
```
|
|
|
|
Build a single binary with embedded web assets:
|
|
|
|
```bash
|
|
bun run build:single-exe
|
|
```
|
|
|
|
## Docs
|
|
|
|
- `cli/README.md` - CLI usage and config
|
|
- `server/README.md` - Server setup and architecture
|
|
- `web/README.md` - Web app behavior and dev workflow
|
|
|
|
## License
|
|
|
|
- cli: MIT
|
|
- others: LGPLv2
|