Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Tunnels

The kimaki tunnel command exposes a local port as a public HTTPS URL through opentunnel.xyz. The user driving the bot from Discord is not at the terminal, so localhost:3000 is useless to them; a tunnel gives them a real URL to open. TLS ends on your machine, so the relay never sees the traffic.

Basic usage

Wrap your dev server command so the local port is detected automatically:
kimaki tunnel -- pnpm dev
Or tunnel an already-running service on a known port:
kimaki tunnel --port 3000
pnpm dev ──▶ tunnel ──▶ https://<name>.<machine id>.opentunnel.xyz ──▶ open anywhere
The first run on a machine creates its tunnel and waits up to a minute for a certificate. The tunnel identity lives in ~/.local/share/opentunnel/default and is shared with the opentunnel CLI.

Passing the public URL to your app

kimaki tunnel injects KIMAKI_TUNNEL_URL into the child process. Wire your app to that variable so OAuth callbacks, webhook URLs, and absolute links use the public tunnel instead of localhost. TRAFORO_URL is set to the same URL for older setups.
# Next.js kimaki tunnel -- sh -c 'APP_URL=$KIMAKI_TUNNEL_URL exec pnpm dev' # better-auth kimaki tunnel -- sh -c 'BETTER_AUTH_URL=$KIMAKI_TUNNEL_URL exec pnpm dev' # Vite kimaki tunnel -- sh -c 'VITE_BASE_URL=$KIMAKI_TUNNEL_URL exec pnpm dev'
The app receives plain HTTP with Host: localhost:<port>, so dev servers that check the host (Vite) work with no allowedHosts config. The public host is in X-Forwarded-Host and the scheme in X-Forwarded-Proto: https.
When launching a dev server through kimaki tunnel -- ..., the local port is auto-detected from the process output. Only pass --port if detection fails.

Options

OptionDescription
-p, --port <port>Local port (default: read from the command output)
-t, --tunnel-id <id>Fixed subdomain (default: random). Only for public-safe services
--host <host>Local host (default: localhost)
-k, --killKill the process on --port first
Use a random tunnel ID by default. Only pass -t to pick a stable, guessable ID when the service is safe to be publicly discoverable. The ID is lowercased and other characters become dashes, so -t My_App gives my-app. Inside a tuistory session the session ID is used, so restarting the session keeps the URL.

Running it in the background

Keep the tunnel + dev server alive across commands using a background session manager so you can read logs and grab the URL later:
tuistory launch "kimaki tunnel -- pnpm dev" -s myapp-dev tuistory read -s myapp-dev # find the printed tunnel URL