Get Started

Quickstart

This walkthrough takes you from a fresh install to a cloud agent you can pull and push. It assumes you've already installed the CLI.

1. Log in

brainbase login opens the web app and connects this device. The session is stored in ~/.brainbase/auth.json.

bash
brainbase login
brainbase whoami   # confirm who you're signed in as

2. Describe your agent

An agent is declared in a committed brainbase.agent.yaml file — the source of truth for its name, instructions, skills, and MCP servers. Create one in your project folder:

brainbase.agent.yamlyaml
schema: 1
harness: claude-code
agent:
  name: Repo Assistant
  tagline: Reviews PRs and keeps the changelog tidy
instructions:
  file: ./.brainbase/instructions.md
skills:
  - source: registry:brainbase/changelog@^1.0
mcp:
  - name: github
    url: https://api.githubcopilot.com/mcp/
Unclaimed vs claimed
A manifest with no id field is unclaimed — it describes an agent the cloud doesn't know about yet. brainbase agent create claims it by creating the cloud agent and stamping the id back into the same file.

3. Create the cloud agent

bash
brainbase agent create   # claims the manifest, stamps in `id`

4. Push and pull

Edit the manifest by hand, then agent push to send local changes up. Use agent pull to bring a teammate's cloud changes down, and agent status to preview both directions before you run either.

bash
brainbase agent status   # what would push, what would pull
brainbase agent push     # send local changes to the cloud
brainbase agent pull     # bring cloud changes into this folder

Where to go next