@orderful/droid

!Droid and Claude

"Droid, teaching your AI new tricks"

AI workflow toolkit for sharing tools, commands, and agents across the engineering team.

$3

- Lower the barrier to entry - Get started with AI coding tools (Claude Code, OpenCode) without configuring from scratch
- Share what works - Power users discover great workflows, everyone benefits
- Consistent experience - Common patterns like @droid/@user comments work the same across the team

Prerequisites

Before installing droid:

| Requirement | Why | Install |
| -------------------------- | -------------------------------------------- | ---------------------------------------- |
| npm login to @orderful | Droid is published to our private npm org | npm login (use Orderful credentials) |
| bun | Required for droid exec scripts | bun.sh |
| gh (GitHub CLI) | Highly recommended for PR workflows | cli.github.com |
| Obsidian | Recommended for brain/codex markdown editing | obsidian.md |

Setup Gotchas

Things that trip people up:

$3

If claude command isn't found in new terminal windows, add to your shell rc file (.bashrc, .zshrc):

``bash
export PATH="$HOME/.local/bin:$PATH"
`

Then restart your terminal or source the file.

$3

After install, review your configuration before starting a session:

`bash
droid config # View global settings
droid # TUI → Settings tab for tool-specific config
`

Make sure username, paths, and tool settings match what you want.

$3

When droid auto-updates (or you run droid update), the package updates but you need to:

1. Restart droid to pick up the new version
2. Run tool updates separately if needed (droid update in TUI)

$3

Cursor integration currently requires the nightly build of Cursor.

$3

After global npm install, run nodenv rehash (or equivalent for your version manager) to update shims.

Quick Start

$3

`bash
npm install -g @orderful/droid
droid
`

The TUI guides you through setup and tool installation. Works with both Claude Code and OpenCode.

$3

Install directly through Claude Code's plugin system:

`bash


Add the Droid marketplace

/plugin marketplace add orderful/droid

Install all droid tools

/plugin install droid@droid
`

The TUI

Run droid to launch the interactive dashboard:

`
┌─────────────────────────────────────────┐
│ @orderful/droid │
│ "Droid, teaching your AI new tricks" │
├─────────────────────────────────────────┤
│ > Tools Browse and install tools │
│ Settings View/edit configuration │
└─────────────────────────────────────────┘
`

Browse available tools, see what's installed, and manage everything from one place.

Available Tools

| Tool | Description | Status |
| --------------- | ----------------------------------------------------------------- | ------ |
| comments | Inline @droid/@user conversations in any file | beta |
| project | Persistent project context across sessions | beta |
| brain | Collaborative scratch pad for planning & research | beta |
| plan | Task-scoped planning with portable, structured plans | alpha |
| coach | Learning-mode AI - scaffolds don't implement, questions don't fix | beta |
| codex | Shared organizational knowledge - PRDs, tech designs, patterns | beta |
| code-review | Multi-agent code review with specialized checkers | alpha |
| tech-design | Three-document approach for technical designs | beta |
| wrapup | Session wrap-up that captures decisions to persistent docs | alpha |
| status-update | Generate and post project status updates to Slack | beta |

$3

Leave notes for your AI with @droid, get responses addressed to you:

`markdown
> @droid Should we cache this query?

> @fry Yes, add Redis caching. The query runs on every request.
`

$3

Maintain context across sessions for long-running work:

`bash
/project myfeature # Load project context
/project update # Capture new learnings
/project create auth # Start a new project
`

$3

Collaborative thinking space for planning and research:

`bash
/brain plan auth refactor # Create planning doc
/brain research caching # Research doc
/brain check # Check for @mentions
`

$3

Run comprehensive reviews with specialized agents:

`bash
/code-review #123 # Review a PR
/code-review staged # Review staged changes
/code-review path/to/file # Review specific file
`

$3

Three-document approach for technical designs (requires brain + codex):

`bash
/tech-design start auth-refactor # Start a new tech design
/tech-design draft api # Draft a section
/tech-design publish # Publish roll-up to codex
`

Creates: research doc (codebase discoveries) → thought doc (design workspace) → roll-up (clean summary).

$3

Capture session context before ending:

`bash
/wrapup # Run session wrap-up
`

Extracts decisions, learnings, and open items to project files and brain docs.

$3

Post project status updates to Slack:

`bash
/status-update # Generate and post status update
`

Pulls context from codex projects and Jira, formats with phase checklists, posts to Slack (or prints to terminal). Requires one-time setup:

`bash
droid auth slack # Set up Slack OAuth (per user)
`

Configuration

Config lives in ~/.droid/:

`
~/.droid/
├── config.yaml # Global config (platform, user settings, tool config)
└── skill_overrides/ # User-defined skill behaviour overrides
├── _template.md # Template and instructions
└── {skill}.md # Override for specific skill
`

Key sections in config.yaml:

- platform - Primary platform (claude-code, opencode, cursor)
- user_mention - Your @mention for comments (e.g., @fry)
- tools - Per-tool configuration (brain paths, codex repo, etc.)
- auto_update - Auto-update settings for app and tools
- repos - Known repositories for context

$3

Customize skill behaviour without forking droid. Create override files in ~/.droid/skill_overrides/ to replace specific commands with your own instructions.

Example: Use semantic search with qmd instead of filename matching for /brain search:

1. Ask droid: "Create an override for brain search that uses qmd"
2. Droid creates ~/.droid/skill_overrides/brain.md with your instructions
3. Droid registers it in config
4. Next /brain search uses your qmd workflow

See ~/.droid/skill_overrides/_template.md for format details.

Where tools install:

Skills are unified across all platforms to ~/.claude/skills/. Commands and agents are platform-specific:

| Platform | Skills | Commands | Agents |
| ----------- | ------------------- | ----------------------------- | --------------------------- |
| Claude Code | ~/.claude/skills/ | ~/.claude/commands/ | ~/.claude/agents/ |
| OpenCode | ~/.claude/skills/ | ~/.config/opencode/command/ | ~/.config/opencode/agent/ |
| Cursor | ~/.claude/skills/ | ~/.cursor/commands/ | ~/.cursor/agents/ |

CLI Reference

While the TUI is the primary interface, direct commands are available:

| Command | Description |
| ----------------------------- | ---------------------------------- |
| droid | Launch TUI dashboard |
| droid setup | Run setup wizard |
| droid install | Install a tool |
| droid uninstall | Remove a tool |
| droid update | Update droid and tools |
| droid config | View/edit config |
| droid auth | Show authentication status |
| droid auth slack | Set up Slack OAuth for status updates |
| droid exec