Documentation Login Register
      __ _    ___    __ _   _ __   ___ 
     / _` |  / _ \  / _` | | '__| / __|
 _  | (_| | |  __/ | (_| | | |    \__ \
(_)  \__, |  \___|  \__,_| |_|    |___/
     |___/                             
$ gears init
# Creates .gears directory structure in your project
Creating .gears directory...
├── sessions/ # Daily AI conversation logs
├── story/ # Feature specifications
├── adr/ # Architecture decisions
├── memory/ # Project knowledge base
└── context/ # Current work tracking
[OK] .gears initialized

Why Gears?

🤖 Agent Agnostic

Works with the agent you're already using.

Claude, Cursor, GitHub Copilot, or any AI coding assistant—Gears doesn't replace your tools, it enhances them.

📁 Markdown-Based Context

The workspace holds everything your agent needs.

/.gears/
sessions/ # Daily logs
story/ # Features
adr/ # Design patterns
memory/ # System knowledge

🔌 Your Agent Skills Expanded

Gears does not replace your agent's skills or internal features.

It works alongside your agent's existing capabilities—skills, custom instructions, conversation memory, and workspace tools. Gears adds project context without interfering.

⚡ Agent-Driven Commands

Commands inform your AI how your project works.

When agents run gears commands, they mine the .gears directory alongside your project files to understand architecture, patterns, and context.

🔗 Connected Systems

Inform your AI how systems work together.

workspace-root/
/.gears # Shared context
/projects/front-end # Git repo
/projects/back-end # Git repo
/projects/mobile # Git repo

👥 Use Multiple Agents

Different agents, same context.

Example 1
Claude → Generating code
Cursor → Writing unit tests
Example 2
Claude → Working front end
Copilot → Working back end

💰 Save on Tokens

Pre-documented context reduces exploration.

When agents run gears commands, they receive structured instructions about complex systems—cutting down on expensive context exploration and token usage.

📦 Install Gears

Two ways to get started:

# Option 1: Go install
$ go install github.com/Syluxso/gears@latest
# Option 2: Ask your agent
"Please tell me about this system:
https://mygears.dev/docs/getting-started"

🚀 Educate Your Agent in Seconds

One command creates everything.

$ run gears init

The command creates the .gears files and returns prompts to help your agent fill out system design documentation.

☁️ Optional Cloud Backup

Sync your workspace files to mygears.dev

Not required, but useful for backing up sessions, stories, and architectural decisions across machines.

# Authenticate once
$ run gears auth
# Push your files
$ run gears sync push
# Pull from another machine
$ run gears sync pull