vrr/goose
2
0
Fork 0
mirror of https://github.com/block/goose.git synced 2026-04-30 12:39:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 26
goose/crates/goose-cli/WEB_INTERFACE.md
Angie Jones 2032c7099c
Some checks failed
CI / changes (push) Has been cancelled
Details
Canary / Prepare Version (push) Has been cancelled
Details
Deploy Documentation / deploy (push) Has been cancelled
Details
Documentation Site Preview / deploy (push) Has been cancelled
Details
Publish Docker Image / docker (push) Has been cancelled
Details
Canary / Upload Install Script (push) Has been cancelled
Details
Canary / bundle-desktop (push) Has been cancelled
Details
Canary / bundle-desktop-linux (push) Has been cancelled
Details
Canary / bundle-desktop-windows (push) Has been cancelled
Details
Canary / Release (push) Has been cancelled
Details
CI / Check Rust Code Format (push) Has been cancelled
Details
Canary / build-cli (push) Has been cancelled
Details
CI / Build and Test Rust Project (push) Has been cancelled
Details
CI / Lint Electron Desktop App (push) Has been cancelled
Details
CI / bundle-desktop-unsigned (push) Has been cancelled
Details
lowercase g in goose (#4832)
2025-09-26 23:44:38 -05:00

2.2 KiB
Raw Blame History

goose Web Interface

The goose web command provides a (preview) web-based chat interface for interacting with goose. Do not expose this publicly - this is in a preview state as an option.

Usage

# Start the web server on default port (3000)
goose web

# Start on a specific port
goose web --port 8080

# Start and automatically open in browser
goose web --open

# Bind to a specific host
goose web --host 0.0.0.0 --port 8080

Features

  • Real-time chat interface: Communicate with goose through a clean web UI
  • WebSocket support: Real-time message streaming
  • Session management: Each browser tab maintains its own session
  • Responsive design: Works on desktop and mobile devices

Architecture

The web interface is built with:

  • Backend: Rust with Axum web framework
  • Frontend: Vanilla JavaScript with WebSocket communication
  • Styling: CSS with dark/light mode support

Development Notes

Current Implementation

The web interface provides:

  1. A simple chat UI similar to the desktop Electron app
  2. WebSocket-based real-time communication
  3. Basic session management (messages are stored in memory)

Future Enhancements

  • Persistent session storage
  • Tool call visualization
  • File upload support
  • Multiple session tabs
  • Authentication/authorization
  • Streaming responses with proper formatting
  • Code syntax highlighting
  • Export chat history

Integration with goose Agent

The web server creates an instance of the goose Agent and processes messages through the same pipeline as the CLI. However, some features like:

  • Extension management
  • Tool confirmations
  • File system interactions

...may require additional UI components to be fully functional.

Security Considerations

Currently, the web interface:

  • Binds to localhost by default for security
  • Does not include authentication (planned for future)
  • Should not be exposed to the internet without proper security measures

Troubleshooting

If you encounter issues:

  1. Port already in use: Try a different port with --port
  2. Cannot connect: Ensure no firewall is blocking the port
  3. Agent not configured: Run goose configure first to set up a provider