silkweavebox

Docs

Install and run your Box

One command sets up a Box on your computer. It asks before every change, and you can run it again at any time.

Before you start

  • A computer with macOS or Linux, or Windows with WSL (Windows’ built-in Linux).
  • An account with an AI agent: Claude or Codex. If neither is on your computer, the installer offers to install Claude Code. You can sign in later from the Box.
  • An internet connection for the download. The Box and Bun need no administrator password. On Linux and WSL, installing Git (only if it is missing) asks for your computer password.

Install

1First add WSL, Windows’ built-in Linux. Open PowerShell as administrator, run this, then restart:

wsl --install

2Open Ubuntu from the Start menu and paste:

curl -fsSL https://box.silkweave.dev/install | bash

Open Terminal (press ⌘ Space, type “Terminal”), paste the command and press Return.

Open a terminal, paste the command and press Enter.

Press Enter. Everything else happens inside Ubuntu.

What the installer does

It shows five steps and asks before anything changes on your computer.

  1. Checking this computer. It shows your system (for example “Ubuntu 24.04.1 LTS (WSL) on x86_64”) and checks for Git. On a Mac, if Apple’s Command Line Tools (which include Git) are missing, it opens Apple’s installer window: click Install and wait. On Linux and WSL it offers to install Git and unzip with your package manager (apt, dnf, pacman or zypper), which asks for your password.
  2. Preparing the tools. It installs Bun, the runtime the Box runs on, into ~/.bun, or upgrades an older one. If no Claude or Codex agent is found, it offers Claude Code. Node.js is not needed.
  3. Choosing a place for your Box. The Box is a folder with its code and its data. It asks before it creates box in the folder you are in, and lets you pick another place.
  4. Installing the Box. It downloads the Box, installs its parts and adds the box command. It asks before it adds one line to your shell profile so new terminals find that command.
  5. Setting up your Box. A few questions create your owner account. The Box then starts and opens its sign-in page in your browser (on WSL, your Windows browser). If no browser can be opened, the sign-in link stays in the terminal.

Read the script before you run it: install.sh on GitHub, or open /install.

Start and sign in

Your Box runs while its terminal window is open. To start it again later, open a terminal and run:

cd ~/box && bun dev

Use the folder you chose if it is not ~/box. Need a new sign-in link? Inside the Box folder, run this with your owner id:

box auth login <your owner id>

Add features

A new Box starts small. Its first dashboard recommends three recipes to adapt first, and the Recipe Gallery (in the Work menu) lists all of them: chat, CRM, planning, wiki, support and more.

Choose Adapt recipe and Builder opens with a short draft brief. You read it, change it if you like, and send it. Nothing happens until you send it. The agent then adapts the recipe into your Box and checks that everything still works. You can also ask Builder for something of your own, in plain words. See the recipes.

Run it again

Running the installer again is safe. Finished steps are skipped, and if it finds a Box in the folder it asks whether to continue setting up that Box.

Options

Options are environment variables for bash, for example:

curl -fsSL https://box.silkweave.dev/install | BOX_DIR=~/work/box bash
BOX_DIR=<path>
Where to create the Box. Default: a folder called box where you run the command (you are asked first).
BOX_YES=1
Accept every default without asking. Setup then runs without questions too.
BOX_REF=<branch>
A branch or tag of the Box to check out. Default: the latest.
BOX_REPO=<url>
Another Box repository to clone. Default: https://github.com/silkweave/box.git
NO_COLOR=1
Plain output without colours.

If something goes wrong

“The installer asks a few questions and needs a terminal.”
Run the command in a terminal window (Terminal on a Mac, Ubuntu on Windows), or add BOX_YES=1 to accept every default.
A step failed
The installer shows the last lines of what went wrong. Fix that, then run the installer again: finished steps are skipped.
“Timed out waiting for the Command Line Tools.”
Finish Apple’s installer window, then run the installer again.
“On Windows, the Box runs inside WSL.”
You ran the command in Git Bash or another Windows shell. In PowerShell run wsl --install, restart, open Ubuntu and run the command there.
“The installer is temporarily unavailable.”
The download could not be reached. Try again in a minute.

Remove a Box

Stop the Box (close its terminal window, or press Ctrl C in it), then delete its folder. That removes its code and its data. The box command lives in ~/.local/bin/box; Bun stays in ~/.bun for other programs that use it.