Install and sign in
Start with one Agent and one conversation. Add tools and capabilities when your work needs them.
1. Install Rulith
Install Node.js 20 or newer, then run these commands in your terminal:
npm install --global rulith
rulith startOpen the local URL printed by the command. Keep that terminal open while you use Rulith. The URL includes a per-run access key; use the newly printed URL after a restart and keep it private.
You can also start without a global installation:
npx --yes rulith@latestThis guide was verified against Rulith 0.8.17. The document assistant additionally requires Java 25; ordinary conversation does not.
2. Sign in
Open Sign in at the bottom left. The browser opens a dedicated Rulith sign-in page. Continue with the displayed account or choose GitHub or Google to use another one. The provider may ask you to authenticate.
After approval, return to the local workbench. Its account name and enabled Agents should appear. You do not need to copy an Agent token or a pairing code for this path.
If no Agent is enabled, open Agents in Console, create or enable one, then choose Refresh enabled Agents in the local account menu.
3. Choose an Agent
Select an Agent in the left sidebar and follow its setup prompt. Choose the local Agent option when Rulith will run the model. The option for an existing MCP client prepares a Worker while that client continues to run its own model.
Wait for connection setup to finish. The selected Agent controls the conversation and Worker panels; the account menu remains at the bottom left.
4. Set the model and start
Open the account menu and choose Default model. Enter the provider's endpoint, model name and API key. Use the API format offered by your provider. A local model endpoint may work without a key.
New Agent profiles follow this local default. To override it, open the selected Agent's gear menu and choose Model settings.
Use Save and start Agent, or save and then press Start Agent. Send a short message once the Agent reports ready. A successful reply verifies the model connection; it does not by itself verify a capability or an external tool.
Model settings belong to this account on this computer. They are not uploaded as Console account defaults. Restart an inheriting Agent after changing the default.
5. Add work when needed
Press Start Worker when the task needs local tools. Install a capability and configure its Sources in Console, or use the document assistant for the provided document-to-draft example.
A running Worker alone does not grant permission to every file or service. Follow Files and permissions before adding sensitive material.
Stop, update and return
Stop a selected role with Stop Agent or Stop Worker. To close the workbench, stop its roles and press Ctrl+C in the terminal where you started it.
For an update, stop the running installation, run the install command again, then run rulith start. Open its new URL. Do not start a second workbench over the same profile directory.