Getting Started

This guide will walk you through setting up your first Gyrus workspace and connecting it to AI agents.

Prerequisites

Make sure you have installed Gyrus before continuing.

Initialize Your First Workspace

Create your first workspace with a single command:

gyrus init

This creates a default workspace at ~/gyrus with the standard folder structure.

Custom Location

Specify a custom path, name, and description:

gyrus init ~/my-brain --name personal --description "Personal knowledge base"

What Gets Created

~/gyrus/
├── knowledge/
│   ├── README.md           # Knowledge system guide
│   ├── index.md            # Master index of notes
│   ├── instructions.md     # AI agent instructions
│   ├── projects/           # Project-specific knowledge
│   ├── patterns/           # Reusable patterns
│   ├── tools/              # Tool and tech notes
│   ├── gotchas/            # Common pitfalls
│   └── decisions/          # Key decisions
├── adrs/
│   └── template.md         # ADR template
└── skills/
    └── index.md            # Skills index

Verify Your Setup

Run the doctor command to ensure everything is configured correctly:

gyrus doctor

This checks:

• ✅ Configuration file exists and is valid
• ✅ Workspace directories are accessible
• ✅ Required folders are present

Add More Workspaces

You can create multiple workspaces for different contexts:

# Work workspace
gyrus init ~/work/brain --name work --description "Work projects"

# Project-specific workspace
gyrus init ./brain --name myproject --description "Project notes"

List all your workspaces:

gyrus workspaces
# or: gyrus ws

Switch between workspaces:

gyrus use work

Connect to AI Agents

To use Gyrus with AI assistants, add it to your MCP configuration.

Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "gyrus": {
      "command": "gyrus",
      "args": ["mcp"]
    }
  }
}

Cursor

Add to your Cursor MCP settings:

{
  "mcpServers": {
    "gyrus": {
      "command": "gyrus",
      "args": ["mcp"]
    }
  }
}

Zed Editor

Add to your Zed settings:

{
  "context_servers": {
    "gyrus": {
      "command": {
        "path": "gyrus",
        "args": ["mcp"]
      }
    }
  }
}

Next Steps

Now that you're set up:

• Learn about workspaces — Manage multiple knowledge bases
• Create knowledge notes — Organize your notes
• Track decisions with ADRs — Document architectural decisions
• Create skills — Reusable AI instructions
• Explore MCP tools — See all available AI tools