Quick Start
Start your first taiku session and share it.
This guide gets you from a fresh install to a live, shareable session.
Check your setup
Make sure taiku is installed and authenticated:
taiku --version
taiku loginIf you have not done that yet, start with Installation.
Start a session
Run:
taikuBy default this opens the desktop app if it is installed. Otherwise it opens the session in your browser.
taiku vX.Y.Z
➜ Link: https://taiku.live/s/abc1234xyz#Kj3mN9...
➜ Admin link hidden. Type a and press Enter to show it.Press Ctrl-C in this terminal to end the session.
The session secret lives in the URL fragment, so each joining client can derive
the terminal encryption key locally while the server only relays encrypted
terminal traffic. (With --enable-readers, taiku prints separate Reader and
Writer links instead of a single Link.)
The Admin link isn't printed. The session taiku opens in your browser or the
desktop app already has it, and so does the one you open from your dashboard
when you're signed in. To see it here, type a and press Enter. Anyone with the
Admin link gets an unsandboxed shell on your machine as you, so keep it to
yourself.
Share the link
Send the session URL to anyone who should join. Depending on your viewer-auth setting, they may also need to sign in before the WebSocket connects.
If you want separate read-only and write links:
taiku --enable-readersExplore the workspace
Inside the session, you can:
- split panes
- create more workspaces
- open tunnels with
--tunnel 3000 - use built-in chat
End the session
Press Ctrl-C in the terminal running taiku, or close the desktop window. The
session stays around briefly for reconnection, then shuts down.
Common flags
| Flag | What it does |
|---|---|
--no-app | Run in CLI-only mode without opening the desktop app |
--tunnel 3000 | Expose local port 3000 as an HTTP tunnel visible in the session |
--enable-readers | Generate separate reader, writer, and admin links, each a standalone URL |
--shell /bin/zsh | Use a specific shell instead of your system default |
--sandbox . | Restrict the session's filesystem access to the current directory |
For the full flag list, see the CLI reference.
Next steps
Once your first session is up, these are the next docs to read:
- Share a Session: how links, roles, reconnection, and access control work.
- HTTP Tunnels: expose local web servers and APIs to your collaborators.
- Collaboration: split panes, hand off shells, and work together effectively.
- Workspaces: manage multiple workspaces and tiled layouts.
- Files and Documents: open paths from terminal output, inspect PDFs/media inline, and move files into editor tiles.