@build-on-record/cli

CLI for Build on Record - log your build progress from the command line.

Installation

npm install -g @build-on-record/cli

Quick Start

1. Login to your Build on Record account:

   bor login

2. Set a project to log to:

   bor project set <project-slug>

3. Log your progress:

   bor "Implemented user authentication"

Commands

Authentication

bor login              # Login with email/password
bor logout             # Logout and clear credentials
bor whoami             # Show current user

Projects

bor project list       # List your projects
bor project set <slug> # Set default project for logging
bor project show       # Show current default project

Logging

bor log                     # Interactive log entry
bor log -t "Title" -c "Content"  # Quick log with title and content
bor "Quick message"         # Shorthand for quick logging

Configuration

bor config show        # Show current configuration
bor config url         # Show/set API URL
bor config reset       # Reset to defaults

API URL Configuration

By default, the CLI connects to the production API. You can configure a different URL:

# Use production (default)
bor config url production

# Use staging
bor config url staging

# Use custom URL
bor config url https://your-api.example.com

Requirements

• Node.js 18 or higher
• A Build on Record account

Links

• Website
• GitHub
• Report Issues

License

MIT