mirror of
https://github.com/wu736139669/hapi.git
synced 2026-08-05 06:24:37 +00:00
weishu
c3c89a2773
Update documentation across README, installation, and quick-start guides to highlight the new relay-based access method with WireGuard + TLS end-to-end encryption. Changes include: - Recommend `hapi server --relay` as the default startup command - Explain URL and QR code generation in terminal for instant access - Note end-to-end encryption for security assurance - Reorganize self-hosted tunnel options (Cloudflare, Tailscale, IP) - Update website installation steps and add E2EE badge
59 lines
1.1 KiB
Markdown
59 lines
1.1 KiB
Markdown
# Quick Start
|
|
|
|
<Steps>
|
|
|
|
## Install HAPI
|
|
|
|
::: code-group
|
|
|
|
```bash [npm]
|
|
npm install -g @twsxtd/hapi
|
|
```
|
|
|
|
```bash [Homebrew]
|
|
brew install tiann/tap/hapi
|
|
```
|
|
|
|
```bash [npx (one-off)]
|
|
npx @twsxtd/hapi
|
|
```
|
|
|
|
:::
|
|
|
|
Other install options: [Installation](./installation.md)
|
|
|
|
## Start the server
|
|
|
|
```bash
|
|
hapi server --relay
|
|
```
|
|
|
|
On first run, HAPI prints an access token and saves it to `~/.hapi/settings.json`.
|
|
|
|
The terminal will display a URL and QR code for remote access.
|
|
|
|
> End-to-end encrypted with WireGuard + TLS.
|
|
|
|
## 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
|
|
- [Remote access](./installation.md#remote-access) - Access HAPI from anywhere
|
|
- [Notifications](./installation.md#telegram-setup) - Set up Telegram notifications
|
|
- [Install the App](./pwa.md) - Add HAPI to your home screen
|