Files
hapi/docs/guide/quick-start.md
T
weishu 68f4f336c9 docs: clarify server deployment options and remote access methods
- Support both local and remote server deployment
- Add direct public IP access option for remote servers
- Remove tunnel requirement messaging
- Organize remote access options with details sections
2026-01-02 12:56:44 +08:00

58 lines
879 B
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](/guide/installation)
## Start the server
```bash
hapi server
```
On first run, HAPI prints an access token and saves it to `~/.hapi/settings.json`.
## Start a coding session
```bash
hapi
```
This starts Claude Code wrapped with HAPI. The session appears in the web UI.
## Open the UI
Open your browser:
```
http://<your-ip>:3006
```
Enter your access token to log in.
</Steps>
## Next steps
- [Remote access](/guide/installation#remote-access) - Access HAPI from anywhere
- [Notifications](/guide/installation#telegram-setup) - Set up Telegram notifications
- [Install the app](/guide/pwa) - Add HAPI to your home screen