mirror of
https://github.com/wu736139669/hapi.git
synced 2026-08-05 06:24:37 +00:00
weishu
b7503d9309
- split installation.md into installation/deployment/notifications - merge cursor/grok guides into new agents.md with full support matrix - sidebar: grouped sections; add namespace, deployment, notifications, native companion contract - fix license footer (AGPL-3.0), settings schema fields and $id - fix drift in pwa, faq, namespace, how-it-works, voice-assistant, quick-start, native-companion-contract - move mermaid lightbox dogfood doc to localdocs (untracked) - README: complete agent list, replace dead cursor/grok links
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# Quick Start
|
|
|
|
<Steps>
|
|
|
|
## Install HAPI
|
|
|
|
```bash
|
|
npm install -g @twsxtd/hapi --registry=https://registry.npmjs.org
|
|
```
|
|
|
|
Other install options (Homebrew, npx, prebuilt binary, source): [Installation](./installation.md#install-the-cli)
|
|
|
|
## Start the hub
|
|
|
|
```bash
|
|
hapi hub --relay
|
|
```
|
|
|
|
On first run, HAPI prints an access token and saves it to `~/.hapi/settings.json`. The terminal displays a URL and QR code for remote access.
|
|
|
|
Details and local-only mode: [Hub setup](./installation.md#hub-setup)
|
|
|
|
## Start a coding session
|
|
|
|
```bash
|
|
hapi
|
|
```
|
|
|
|
This starts Claude Code wrapped with HAPI. The session appears in the web UI.
|
|
|
|
## Open the UI
|
|
|
|
Open the URL shown in the terminal, or scan the QR code with your phone.
|
|
|
|
Enter your access token to log in.
|
|
|
|
</Steps>
|
|
|
|
## Next steps
|
|
|
|
- [Seamless Handoff](./how-it-works.md#seamless-handoff) - Switch between terminal and phone seamlessly
|
|
- [Hub setup](./installation.md#hub-setup) - Access HAPI from anywhere
|
|
- [Notifications](./notifications.md#telegram-setup) - Set up Telegram or ServerChan notifications
|
|
- [Deployment](./deployment.md) - Run HAPI as a persistent background service
|
|
- [Install the App](./pwa.md) - Add HAPI to your home screen
|