Workspace

By default, Bub runs in a workspace, which is simply a directory. It reads information and instructions about the current workspace from there.

Prepare a workspace (optional)

If you don’t have a project yet and are just getting started with Bub, create a directory first:

mkdir hello-bub
cd hello-bub

Then create an AGENTS.md file in that directory and write the following content into it:

You are the Bub agent for this workspace.
Read the relevant content before editing files.
Keep replies short and specific.

From then on, each time Bub runs, it reads these rules from the instructions so the model can follow them in its output. After trying the example, keep editing this file and see how the model’s output changes under different rules.

Check commands

Now try listing the commands available in Bub from the terminal in a workspace:

bub run ",help"

From then on, any input that starts with a , comma calls the related command. You can change it to any character you like in the settings.