Skip to content
term-serve

Getting Started

term-serve exposes a real local terminal session in your browser. By default it stays local-only and opens a shell.

Launch in shell mode

Section titled “Launch in shell mode”
Terminal window
# Run from this repository
bun run src/bin/term-serve.ts


# If installed as a binary
term-serve

Then open http://127.0.0.1:31337/.

Desktop shell session in term-serve
Default desktop shell session.

Run a command instead of a login shell

Section titled “Run a command instead of a login shell”

Everything after the command name is passed through unchanged to the PTY process:

Terminal window
term-serve htop -d 10
term-serve btop
term-serve opencode

Use -- when you need to separate term-serve options from command arguments:

Terminal window
term-serve --port 4141 -- rg --hidden TODO src

Start in a specific directory

Section titled “Start in a specific directory”
Terminal window
term-serve --cwd ~/projects

Share on LAN (with token auth)

Section titled “Share on LAN (with token auth)”
Terminal window
term-serve --public

When binding non-locally, term-serve requires an auth token for WebSocket terminal access:

  • Provide one explicitly with --auth-token <secret>.
  • Or let term-serve generate one at startup and print it once.

Next steps

Section titled “Next steps”