mirror of
https://github.com/wu736139669/hapi.git
synced 2026-10-09 19:29:41 +00:00
48 lines
1.6 KiB
Markdown
48 lines
1.6 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 web URL and two QR codes for web access and native app pairing.
|
|
|
|
Details and local-only mode: [Hub setup](./installation.md#hub-setup)
|
|
|
|
## Start a coding session
|
|
|
|
```bash
|
|
hapi
|
|
```
|
|
|
|
Choose an installed agent from the picker. Its session appears in connected web and native clients.
|
|
To start one directly, use `hapi claude`, `hapi codex`, or another
|
|
[supported agent command](./agents.md). Scripts must specify the agent explicitly.
|
|
|
|
## Open the UI
|
|
|
|
- **Web / PWA:** open the web URL shown in the terminal, or scan the web QR code. Enter your access token if prompted.
|
|
- **Native iOS / Android:** open the app and scan the companion QR, or enter the HTTPS hub URL and access token. See [Native apps](./native-apps.md) for build and pairing instructions.
|
|
|
|
</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) - Native app, Web Push, Telegram and ServerChan notifications
|
|
- [Deployment](./deployment.md) - Run HAPI as a persistent background service
|
|
- [Native apps](./native-apps.md) - Build, pair and use the iOS / Android clients
|
|
- [Install the PWA](./pwa.md) - Add the web app to your home screen
|