Skip to content

CLAUDE.md

Latest commit

 

History

History
114 lines (87 loc) · 1.98 KB

CLAUDE.md

File metadata and controls

114 lines (87 loc) · 1.98 KB
Raw

BlackRoad CLI

Command-line interface for BlackRoad OS

Quick Reference

Property Value
Runtime Node.js 18+
Binary br / blackroad
Package @blackroad/cli
Type CLI Tool

Installation

# Global install
npm install -g @blackroad/cli

# Or run directly
npx @blackroad/cli

# Development
npm install
npm link

Commands

br --help           # Show all commands
br status           # System status
br agents           # List agents
br agents:wake      # Wake an agent
br deploy           # Deploy to cloud
br mesh             # Check infrastructure mesh
br memory           # Memory operations

Project Structure

bin/
└── br.js           # Main entry point

src/
├── commands/       # CLI commands
├── utils/          # Helpers
├── config/         # Configuration
└── api/            # API client

lib/
└── ...             # Compiled output

Development

npm run dev         # Watch mode
npm run build       # Build
npm run test        # Run tests
npm run lint        # Lint check

Command Development

Adding a new command:

// src/commands/mycommand.js
export default {
  name: 'mycommand',
  description: 'Does something cool',
  options: [
    { flag: '-v, --verbose', description: 'Verbose output' }
  ],
  action: async (options) => {
    // Command logic
  }
}

Configuration

Config file: ~/.blackroadrc or ~/.config/blackroad/config.json

{
  "apiUrl": "https://api.blackroad.io",
  "defaultOrg": "blackboxprogramming",
  "theme": "dark"
}

Environment Variables

BLACKROAD_API_KEY=     # API authentication
BLACKROAD_ORG=         # Default organization
BLACKROAD_DEBUG=1      # Enable debug logging

Publishing

npm version patch
npm publish --access public

Related Repos

  • blackroad-os-web - Web interface
  • blackroad-os-core - Core engine
  • blackroad-os-docs - Documentation