docs: add goose web command (#2856)

This commit is contained in:
dianed-square
2025-06-12 10:00:03 -07:00
committed by GitHub
parent 298b1254a9
commit ff80c2f44a
3 changed files with 72 additions and 10 deletions

View File

@@ -450,6 +450,55 @@ After selecting a project, you'll be asked to either:
- **Start new session**: Start a new session in the selected project
---
### web
Start a new session in Goose Web, a lightweight web-based interface launched via the CLI that mirrors the desktop app's chat experience.
Goose Web is particularly useful when:
- You want to access Goose with a graphical interface without installing the desktop app
- You need to use Goose from different devices, including mobile
- You're working in an environment where installing desktop apps isn't practical
**Usage:**
```bash
goose web
```
**Options:**
- **`-p, --port <PORT>`**: Port number to run the web server on. Default is `3000`.
- **`--host <HOST>`**: Host to bind the web server to. Default is `127.0.0.1`.
- **`--open`**: Automatically open the browser when the server starts.
**Examples:**
```bash
# Start web interface at `http://127.0.0.1:3000` and open the browser
goose web --open
# Start web interface at `http://127.0.0.1:8080`
goose web --port 8080
# Start web interface accessible from local network at `http://192.168.1.7:8080`
goose web --host 192.168.1.7 --port 8080
```
**Limitations:**
While the web interface provides most core features, be aware of these limitations:
- Some file system operations may require additional confirmation
- Extension management must be done through the CLI
- Certain tool interactions might need extra setup
- Configuration changes require a server restart
:::warning
Don't expose the web interface to the internet without proper security measures.
:::
:::info
Use `Ctrl-C` to stop the server.
:::
---
## Prompt Completion
The CLI provides a set of slash commands that can be accessed during a session. These commands support tab completion for easier use.