Getting started¶
This page gets you from nothing to your first agent-driven analysis. For a friendly, click-through installer tailored to your operating system (including Windows), use the interactive install guide. The steps below are the short version.
1. Install biopb¶
For the impatient, here's the command:
For the rest, go to the interactive install guide and follow either route.
What does curl … | bash (or irm … | iex) do?
It downloads the setup script and runs it. You can read exactly what it does first — it's plain text at biopb.org/install.sh (and install.ps1 for Windows).
The installer also registers biopb with any agent it finds — there's nothing to wire up by hand. You can see the list of registered agent apps from the biopb dashboard.
2. Start the agent app¶
Start the agent app of your choice, e.g., Claude Code, opencode, etc. This is the chat interface where you talk to your
LLM agent. If you don't have one pre-installed, the biopb installation may have pulled in opencode for you automatically.
Your first prompt at the chat interface should be:
"Connect to biopb and report status"
Your agent should launch biopb on its own, open a napari viewer, and print out a status report in the chat window.
3. Open the dashboard (optional)¶
The biopb Dashboard app that comes with the installation is the single entry point to view and change configurations. Starting it brings up http://127.0.0.1:8813 in a browser, where you can watch what your agent is running, take a glance at the installed plugins, and check on the data server. You don't need it to get work done — but it's the best window into what's happening underneath. See Working with the dashboard.
Having trouble?¶
Head to Troubleshooting, or reach out via Help & community.