Home › Tutorials
Written Guides
Rysh Tutorials
111 step-by-step written guides — every one paired with a short video, the exact commands shown, and a full transcript. Also available as video tutorials.
01 Getting Started
- #001 What Is Rysh? — A terminal that thinks. Shell mode runs commands. Prompt mode talks to AI.
- #002 Installing Rysh — One command to install. Every platform.
- #003 Building From Source — Rysh is just Go. Clone it, make build, and run your own binary.
- #004 Configuring Rysh — One TOML file controls everything -- and every setting has an env-var override.
02 Sessions & Daemon
- #005 Your First Session — Name a session, work in it, detach -- and it keeps running without you.
- #006 Named & Detached Sessions — Create a session attached, or spin one up headless as a background daemon.
- #007 Attach, Detach, List, Delete — Four commands manage every session's whole lifecycle from outside.
- #008 Sending Input Remotely — Drive a session from the outside -- no attach required.
- #009 Session Persistence — Detach, reattach -- your panes come back exactly as you left them.
03 Tabs
- #010 Tabs Overview — Tabs hold panes, panes hold agents -- and switching between them is one keystroke.
- #011 Tab Mode (Ctrl+T) — Ctrl+T opens tab mode -- create, jump, and move without leaving the keyboard.
- #012 Jump & Rename Tabs — Jump to any tab by number, and give your tabs real names.
- #013 Managing Tabs (##tab) — The ##tab command is your full tab control center.
04 Panes & Splits
- #014 Panes Overview — One window, many minds. Every pane is its own shell and its own AI agent.
- #015 Pane Mode (Ctrl+P) — Ctrl+P is your pane command center -- split, stack, close, and rename without leaving the keyboard.
- #016 Split Right & Split Down — Build any layout from two moves: split right for columns, split down for rows.
- #017 Closing & Renaming Panes — Keep your workspace tidy: close panes you're done with and name the ones you keep.
- #018 Pane Info & Listing (##pane) — Ask rysh about itself -- inspect any pane, list them all, and replay its history.
05 Stacked Panes & Groups
- #019 Stacked Panes — Stack panes like a deck of cards -- many terminals in the footprint of one.
- #020 Stack Mode (Ctrl+S) — Ctrl+S turns a stack into a flip-book -- rotate through your panes with j and k.
- #021 Pane Groups & Lanes — Beneath every layout is a tree -- lanes hold groups, groups hold panes.
- #022 Layout Tree (##pg layout) — See your whole tab at once -- ##pg layout draws the entire structure as a tree.
06 Layout & Resize
- #023 Layout Mode (Ctrl+L) — Ctrl+L is where you shape your workspace -- resize, equalize, swap, and fullscreen.
- #024 Resizing Panes — Give the important pane more room -- arrow keys in layout mode flex the space.
- #025 Equalize, Swap & Fullscreen — Three quick moves to reset chaos: equalize, swap lanes, and go fullscreen.
- #026 Navigate Mode (Ctrl+Space) — Move by direction, not by order -- Ctrl+Space lets you focus panes with arrows.
07 Navigation & Mouse
08 Grid & Bulk Ops
- #030 Instant Grids (##new grid) — Spin up a whole grid of agent panes with a single command.
- #031 Stacks & Pane Groups (##new) — The new command isn't just grids -- it builds any piece of layout.
- #032 Batch Commands (##cmd) — Run the same command across every pane in a scope at once.
- #033 Lanes (##lane / ##new lane) — Lanes are the columns that organize your panes -- manage them directly.
09 Input Modes
- #034 Four Input Modes — One pane, four modes. Double-Escape cycles through them all.
- #035 Shell Mode — Shell mode is a real terminal -- full color, full ANSI, nothing held back.
- #036 Prompt Mode AI — Prompt mode turns your pane into an AI agent that sees your terminal.
- #037 Rysh Mode (## commands) — Hash-hash is rysh mode -- the control panel for your whole workspace.
- #038 Chat Mode — The at-sign prompt is chat mode -- a conversation lane separate from prompt mode.
10 System Commands
- #039 Help & History — Forget a command? Rysh tells you. ##help lists everything, ##history recalls what you typed.
- #040 Inspecting Your Workspace — Lost track of your layout? A handful of ## commands map your entire workspace.
- #041 Snapshots & Clipboard — Grab a pane's output to your clipboard -- raw for you, redacted for sharing.
11 Interactive Terminal
- #042 Running Vim & Htop — vim, htop, less, nano -- full-screen programs just work, right inside a Rysh pane.
- #043 Raw Mode & Escape Hatch — In raw mode every key goes to the program. Ctrl+O is your escape hatch back to Rysh.
- #044 Toggling Raw Mode (##raw) — Need raw mode without an interactive program? ##raw flips it on and off by hand.
- #045 PTY Resize — Resize the window and your programs follow -- SIGWINCH propagates and the emulator reflows.
12 Voice
13 Tools: File & Shell
- #048 The Agentic Toolbelt — Every prompt-mode pane carries 35+ tools -- files, git, code, tests, build, web, and cross-pane coordination.
- #049 Reading & Searching Files — Point the agent at your code -- ls, file_read, glob, and grep find anything, no approval required.
- #050 Editing Files — When the agent edits a file, you see the diff first -- every write waits for your yes.
- #051 Running Bash — Ask in plain English, and the agent runs the shell for you -- dangerous patterns ask first.
- #052 Symbol Search & Code Intelligence — Ask where something is defined -- symbol_search and tree map your code instantly.
14 Tools: Git/Build/Test
- #053 Git Tools — Summarize your changes and commit -- the agent reads git for free, but the commit waits for you.
- #054 Building Your Project — Ask the agent to build -- it compiles, parses the errors, and fixes them.
- #055 Running Tests — Run the tests and fix the failures -- test_run gives structured pass/fail the agent can act on.
- #056 Linting — Lint and fix -- the agent runs go vet, staticcheck, and golangci-lint, then cleans up.
15 Tools: Background & Web
- #057 Background Bash — Long-running jobs don't block the agent -- bash_background returns a session id and keeps running.
- #058 Reading Background Output / Killing — Check on a background job with bash_output, and shut it down with kill_shell.
- #059 Web Search — Ask the agent to search the web -- web_search hits the Brave Search API, no approval needed.
- #060 Web Fetch — Point the agent at a URL -- web_fetch pulls the page and summarizes it for you.
16 Approval & Safety
- #061 Tool Approval Flow — Your AI agent never touches a file or runs a destructive command without your say-so.
- #062 Approve Always & Reject With Reason — Approve once and forever, or reject with a reason the agent can learn from.
- #063 Loop Detection & Last-Prompt-Wins — Runaway agents get stopped, and a new prompt always interrupts the old one.
- #064 Approval Panes — Route every approval request to one dedicated pane and triage them in one place.
17 Context & Memory
- #065 Context Store — Give your agent a memory that survives across the whole session.
- #066 Project Notes — A shared scratchpad your agent reads and writes for the whole project.
- #067 Todo Lists — Watch your agent break a big job into tracked, checkable steps.
- #068 Conversation History & Memory — Recall any pane's conversation, and let old turns compact into summaries.
18 Cross-Pane Coordination
- #069 Pane Listening — Pipe one pane's live output straight into another -- secrets redacted automatically.
- #070 Inspecting & Sending Across Panes — Your agent can read another pane's state and even type into it -- with approval.
- #071 The Hop Command — Hop a pane's output into another and let a fresh agent pick up right where you left off.
- #072 Cross-Pane AI Workflows — Combine listening, inspection, and sending to solve problems across many panes at once.
19 Autonomous Agents
- #073 What Are Autonomous Agents? — Headless AI workers. No terminal, no pane -- just a brain with tools.
- #074 Spawning an Agent — One command, one prompt, and your agent is alive.
- #075 Skill Files — Define an agent once in a file -- name, model, and system prompt -- then spawn it anywhere.
- #076 Spawning From a Directory — A folder of skill files becomes a whole team of agents in one command.
- #077 Talking To & Controlling Agents — @name to prompt it, @@name to command it.
- #078 Routing Agent Output — Send a headless agent's replies straight into a pane you can watch.
20 Humanoids
- #079 What Are Humanoids? — An agent that talks to the outside world -- WhatsApp, Slack, email, phone, chat.
- #080 Spawning a Humanoid — Inline prompt or a skill file with a contacts block -- either way, it's one command.
- #081 Slack Channel — Drop your humanoid into Slack and let it answer threads on its own.
- #082 Email Channel — Give your humanoid an inbox -- it reads incoming mail and writes the replies.
- #083 WhatsApp & Phone Channels — WhatsApp Cloud API and Twilio phone -- your humanoid reaches everyone's pocket.
- #084 Humanoids vs Agents — Same brain, same skill format -- agents face inward, humanoids face the world.
21 Pipelines & Events
- #085 Pipeline Mode — A tab can become a pipeline. One key flips it on and your events start flowing.
- #086 Loading & Running Pipelines (##pipe) — Define a pipeline in a file, load it, run it -- ##pipe drives the whole lifecycle.
- #087 Pipeline Events (##>) — Lines starting with double-hash-greater-than bypass the shell and fly straight to NATS.
- #088 The Softdev Pipeline — One event line can trigger an AI agent to plan, build, lint, and test -- automatically.
- #089 Pipeline Placeholders — Placeholders are lanes reserved for pipeline output -- name them, add them, watch results land.
22 Collaboration & Sharing
- #090 Sharing a Pane — One command publishes a live pane to your workspace -- teammates watch it in real time.
- #091 View vs Control Mode — View lets them watch. Control lets them type. You decide at share time.
- #092 Sharing Groups, Lanes & Tabs — Share one pane, or a whole tab. Each level brings its children along.
- #093 Listing & Unsharing — See everything you're sharing, and pull any of it back with one command.
- #094 Secret Redaction — Your secrets never leave your machine -- redaction happens before output is shared.
23 Upstream & Remote
- #095 Connecting to Upstream — Point Rysh at a workspace URL and an API key -- now your session can join the hub.
- #096 Subscribing to a Remote Share — Discover what your teammates are sharing, then subscribe to watch it live.
- #097 Remote Control — In control mode you don't just watch -- you can drive the remote pane yourself.
- #098 Workspaces (##ws) — A workspace is your shared space -- API-key-scoped, and managed right from rysh mode.
24 Web & Desktop
- #099 Web Terminal (##rysh web) — Your whole rysh workspace, in a browser tab. One command starts it.
- #100 Web Terminal Architecture — No separate service. The web server is baked right into the rysh binary.
- #101 The Desktop App — The same rysh multiplexer, as a native desktop app.
- #102 Multi-Workspace in Desktop — Many workspaces, one window. The desktop app stacks them two rows high.
25 Mobile App
- #103 The Mobile App — rysh in your pocket. Reach your panes from iOS or Android.
- #104 Per-Mode Streams & Scrollback — Shell, AI, Chat, Rysh -- four streams, one pane, all on your phone.
- #105 Overflow Menu & Pane Actions — Long-press a pane on mobile and the full action menu opens up.
- #106 Viewing Shared Tabs on Mobile — A teammate shares a tab -- you open the whole multi-pane layout on your phone.
26 Chrome, Server & Billing
- #107 Chrome Extension Browser Automation — A rysh pane that lives in your browser's side panel and drives the page.
- #108 Browser Tools — Navigate, click, type, screenshot -- the agent's browser toolbelt.
- #109 The Upstream Server — rysh-server: the hub that routes shares between machines.
- #110 Stripe Billing & Plans — Four tiers, Stripe checkout, and limits enforced in three places.
- #111 Chatbot Widget & Connections — Drop a rysh-powered chatbot on your website with one script tag.