@b0xs/recorder

CLI tool for recording terminal sessions to the BOXS platform.

Installation

npm install -g @b0xs/recorder

Usage

First-time Setup

# Authenticate with your API key
boxs login

# Initialize config (optional)
boxs init

Recording a Session

# Start recording
boxs record

# Record with a specific title
boxs record --title "My pentesting session"

# Record and run a specific command
boxs record "nmap -sV scanme.nmap.org"

Options

• --title - Session title
• --description - Session description
• --visibility - Session visibility (public, private, unlisted)

Features

• Real-time upload - Chunks uploaded every 60 seconds
• Offline mode - Continue recording without network, auto-upload when reconnected
• Command detection - Automatically detect and mark commands in timeline
• Crash recovery - Resume incomplete sessions after crashes
• Secure auth - API keys stored in OS keychain

Configuration

Config file: ~/.boxs/config.json

{
  "apiUrl": "https://boxs.sh",
  "defaults": {
    "visibility": "private",
    "chunkDuration": 60000
  },
  "recorder": {
    "promptPatterns": ["\\\\$\\\\s$", "#\\\\s$"],
    "maxBufferedChunks": 10,
    "uploadRetries": 5
  }
}

How It Works

1. Captures terminal - Uses PTY to capture all terminal I/O
2. Encodes with BoxsBinary - Compresses data using custom binary format
3. Uploads chunks - Sends 60-second chunks to BOXS platform
4. Detects commands - Marks command execution for timeline

License

MIT

Related Packages

• @b0xs/binary - Binary format encoder/decoder
• @b0xs/termbox - React player component

Links

• GitHub
• Documentation
• Website