Roo Team Setup

A command-line tool to quickly set up the Roo multi-agent framework workspace in your project.

What is Roo?

Roo is a structured, transparent, and well-documented AI team that delegates its own tasks. It's a comprehensive AI workflow system based on the SPARC framework, enabling efficient task delegation, structured documentation, and knowledge preservation.

Learn more at: The Ultimate Roo Code Hack

Installation & Usage

Using npx (recommended)

The easiest way to use this tool is with npx, which runs it without installing:

npx roo-team-setup

Installing globally

Alternatively, you can install the tool globally:

npm install -g roo-team-setup

Then run it anytime:

roo-team-setup

What Gets Created

The tool prompts you to choose between:

Full Project Setup

Creates a complete Roo framework structure:

/
├── .roo/                     # Configuration files
│   ├── rules/                # General rules
│   ├── rules-orchestrator/   # Mode-specific rules
│   ├── rules-code/
│   ├── ...other mode rules
│   ├── config.json           # Framework configuration
│   └── logs/                 # Log directories
├── .roomodes                 # Mode definitions for VSCode
├── agents/                   # Agent definitions
│   ├── orchestrator/
│   ├── code/
│   └── ...other agents
├── framework/                # Framework documentation
├── best-practices/           # Best practices guides
└── templates/                # Reusable templates

Configuration Only

Creates just the essential configuration files:

/
├── .roo/                     # Configuration files
│   ├── rules/                # General rules
│   ├── rules-*/              # Mode-specific rules
│   ├── config.json           # Framework configuration
│   └── logs/                 # Log directories
└── .roomodes                 # Mode definitions for VSCode

Available Modes

The setup includes configuration for these specialized modes:

• 🪃 Orchestrator: Task decomposition, assignment, and verification
• 💻 Code: Software implementation and optimization
• 🏛️ Architect: System design and pattern application
• ❓ Ask: Information retrieval, evaluation, and communication
• 🪲 Debug: Problem diagnosis and solution validation
• 💾 Memory: Knowledge storage, organization, and retrieval
• 🔍 Deep Research: In-depth investigation and analysis

Requirements

• Node.js 14 or newer
• Compatible AI assistant that supports custom modes

License

MIT

For Package Maintainers

If you're maintaining this package and need to publish it to npm, follow these steps to set up authentication:

Setting up NPM_TOKEN in GitHub Secrets

1. Create a new npm access token:

   • Go to your npm account settings at https://www.npmjs.com/settings/your-username/tokens
   • Click "Generate New Token" → "Classic Token"
   • Select "Automation" as the token type (gives publish access)
   • Copy the generated token

2. Add token to GitHub repository secrets:

   • Go to your GitHub repository → Settings → Secrets and variables → Actions
   • Click "New repository secret"
   • Name: NPM_TOKEN
   • Value: Paste your npm token
   • Click "Add secret"

3. Verify workflow file:

   • Make sure the GitHub Actions workflow in .github/workflows/npm-publish.yml is using the correct secret name

After setting up the token, any pushes to the main branch that modify files in the roo-team-setup directory will trigger an automatic publish to npm with an incremented version number.

Troubleshooting Tools

This package includes diagnostic tools to help troubleshoot npm publishing issues:

1. Workflow Status Checker

Check the status of GitHub workflow runs and analyze failures:

# Export your GitHub token first
export GITHUB_TOKEN=your_github_personal_access_token
npm run check-workflow

This tool will:

• List recent workflow runs
• Show detailed information about failed runs
• Provide specific guidance for npm publishing errors

2. NPM Authentication Tester

Test your local npm configuration and authentication status:

npm run test-npm-auth

This tool will:

• Check npm version and registry configuration
• Verify existence and content of .npmrc files
• Test your npm authentication status
• Examine package.json configuration
• Provide recommendations for fixing common issues

These tools can help diagnose issues with GitHub Actions npm publishing by comparing your local setup with the GitHub Actions environment.