Skip to content

CLI reference

Start a new collaborative terminal session.

Terminal window
taiku [OPTIONS]
OptionDescription
--shell <SHELL>Shell to use (default: $SHELL)
--name <NAME>Session display name (default: user@hostname)
--no-appDon’t open the desktop app, CLI-only mode
--appForce open the desktop app with the session URL
--enable-readersGenerate separate read-only and write URLs
--no-viewer-authAllow anonymous viewers without the encryption key (Pro)
--token <TOKEN>Use a specific API token
--tunnel <PORTS>Expose local ports as HTTP tunnels (comma-separated)
--open-tunnelAuto-approve all tunnel port requests
Terminal window
# Basic session
taiku
# With tunnels for a web dev server
taiku --tunnel 3000,5173
# Read-only sharing (separate write link)
taiku --enable-readers
# Headless server, no desktop app
taiku --no-app --shell /bin/bash

Authenticate with your taiku account.

Terminal window
taiku login

Opens a browser for OAuth (Google or GitHub). On headless machines, prints a URL and code to enter manually. Credentials saved to ~/.config/taiku/credentials.

Expose a local port through an HTTP tunnel within an active session.

Terminal window
taiku tunnel <PORT>

When starting a session, credentials are resolved in this order:

  1. --token flag
  2. TAIKU_TOKEN environment variable
  3. ~/.config/taiku/credentials (if server URL matches)
  4. Anonymous (no auth)
{
"server": "https://taiku.live",
"api_key": "...",
"email": "user@example.com"
}
VariableDescription
SHELLDefault shell for new sessions
TAIKU_TOKENAPI token (alternative to --token or credentials file)
TAIKU_SERVEROverride the server URL