CLI Guide

Log your build progress directly from the command line.

Installation

Install the Build on Record CLI globally using npm:

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

Or with pnpm:

pnpm add -g @build-on-record/cli

Authentication

Before logging records, you need to authenticate with your API token.

1. Get your API token

Navigate to Settings and find your API token in the "CLI Access" section.

2. Log in with your token

bor login

You'll be prompted to enter your API token. The token is stored securely on your local machine.

3. Verify authentication

bor whoami

This displays your username and email to confirm you're logged in.

Commands

Authentication Commands

bor login

Authenticate with your API token.

bor logout

Remove stored credentials.

bor whoami

Display current user information.

Project Commands

bor projects

List all your projects.

bor project show

Display the currently selected default project.

bor project set <slug>

Set a default project for logging. Use the project slug (the URL-friendly name).

bor project clear

Clear the default project.

Logging Commands

bor log <message>

Log a new record to your default project.

bor log -p <project-slug> <message>

Log to a specific project (overrides default).

bor log --private <message>

Create a private record (not visible on public project pages).

Configuration Commands

bor config get api-url

Display the current API URL.

bor config set api-url <value>

Set the API URL. Use "production", "staging", or a custom URL.

bor config reset api-url

Reset API URL to the default (production).

Examples

Quick Setup

# Install the CLI
npm install -g @build-on-record/cli

# Log in with your API token
bor login

# Set your default project
bor project set my-awesome-project

# Log your first record
bor log "Started working on the landing page"

Daily Workflow

# Log progress throughout the day
bor log "Implemented user authentication"
bor log "Fixed bug in the checkout flow"
bor log "Refactored database queries for better performance"

# Log a private note
bor log --private "Need to follow up on API rate limiting"

Working on Multiple Projects

# Log to different projects
bor log -p main-app "Added new dashboard feature"
bor log -p side-project "Initial commit"

# Or switch default projects
bor project set side-project
bor log "Working on this now"

Configuration

The CLI stores configuration in your user directory. Configuration includes:

API Token - Your authentication credentials
Default Project - The project used when no project is specified
API URL - The backend API endpoint (defaults to production)

All settings persist across terminal sessions.

Getting Help

Use the --help flag with any command to see available options:

bor --help
bor log --help
bor project --help
bor config --help