@senpiper/sp-web
v0.1.7
Published
Senpiper Workbench, a local workspace for terminal-owned agent sessions
Readme
Senpiper Workbench
Senpiper Workbench is a local browser workspace for terminal-owned agent sessions. It provides chat, saved history, native questions, a file explorer, Git diffs and workspace shells. The terminal app owns every agent writer. The web server sends bridge commands and never starts a second agent runtime.
Install and run
Requires Node.js 22.19.0 or newer. One installation provides both the terminal agent and Senpiper Workbench:
npm install -g @senpiper/sp-agent
spThe terminal agent starts the web sidecar automatically. Open http://127.0.0.1:30141
in your browser. Start a Senpiper Workbench terminal instance to use live chat; saved
history remains readable without creating a web-owned writer.
For manual server startup, set SP_WEB_DISABLE=1 when launching sp,
then run sp-web in another terminal. The manual launcher opens a browser
when ready. Do not start a second web server on a port already in use.
The workspace terminal uses @lydell/node-pty, a node-pty distribution with
prebuilt binaries for Linux, macOS and Windows (x64 and arm64) delivered as
optional per-platform packages. It has no install scripts and needs no
compiler; do not install with --omit=optional. Windows shells use ConPTY
with PowerShell 7 (pwsh.exe) when available, then Windows PowerShell, then
%ComSpec%.
Configuration
CLI options override environment settings.
| Option or variable | Purpose |
| --- | --- |
| --port, -p, SP_WEB_PORT | Port, default 30141 |
| --hostname, -H, SP_WEB_HOSTNAME | Bind address, default 127.0.0.1 |
| --no-open, SP_WEB_NO_OPEN=1 | Disable browser opening |
| --help, -h | Print help without starting a server |
| SP_WEB_PASSWORD | Basic Auth password, username sp |
| SP_WEB_ALLOWED_HOSTS | Additional exact hostnames, comma-separated |
| SP_WEB_SKIP_VERSION_CHECK=1 | Disable Senpiper Workbench package update checks |
| SP_CODING_AGENT_SESSION_DIR | Custom sp session directory, listed in history beside the default store |
For remote access, require a password and HTTPS through a trusted reverse proxy or a trusted VPN. Basic Auth alone does not encrypt credentials.
SP_WEB_PASSWORD='a-long-random-password' sp-web -H 0.0.0.0 --no-openThe file browser only authorizes known workspace roots. Shells and Git writes
require password authentication or the launcher's verified loopback bind.
Direct next dev and next start launches require a password for these
operations. The workspace shell runs as your OS user and is not a sandbox.
Senpiper Workbench discovery defaults to ~/.sp/agent/web-bridge/discovery.
SP_CODING_AGENT_DIR and SP_TERMINAL_BRIDGE_DISCOVERY_DIR remain native
terminal settings. Existing browser preferences and history are retained.
See branding and compatibility for legacy aliases.
License
MIT. Third-party notices preserve upstream and T3 Code attribution.
