@bitcomplete/bitcat

Bitcat CLI

Bitcat is the CLI interface for BitComplete's BitHub platform. It helps you track git commits across multiple projects and generate automated situation reports (sitreps).

Installation

npm install -g @bitcomplete/bitcat

Requirements

• Node.js ≥ 20
• Git repositories you want to track

Authentication

Before using Bitcat, you need to authenticate with the BitComplete platform:

bitcat login

This will open your browser for OAuth authentication. Once completed, you'll be logged in and can use all features.

To logout:

bitcat logout

Commands

Project Management

Add a Project

Add a git repository for sitrep tracking:

bitcat track <path>

Example:

bitcat track /path/to/your/project
bitcat track .  # Add current directory

When adding a project, you'll be prompted to:

• Select which git email addresses to track
• Set the starting date for commit tracking

Situation Reports (Sitreps)

Check Status

View commit status for all tracked projects:

bitcat status

Add -v or --verbose for detailed commit information:

bitcat status --verbose

Generate Sitrep

Generate and manage a sitrep from all tracked commits:

bitcat sitrep

This command will:

• Gather commits from all tracked projects since the last sitrep
• Generate an AI-powered summary of your work
• Allow you to copy the summary to clipboard
• Save the summary to a file
• Update tracking dates for all projects

Features

• Multi-project tracking: Track commits across multiple git repositories
• Email filtering: Only track commits from specific email addresses
• AI-powered summaries: Generate intelligent summaries of your development work
• Clipboard integration: Easily copy generated reports
• File persistence: Save reports and maintain project state
• OAuth authentication: Secure login with BitComplete platform

Development

Setup

bun install

Development

Start the interactive development terminal with auto-rebuild:

bun run dev

This starts an interactive terminal where you can run bitcat commands directly:

bitcat> login
bitcat> track .
bitcat> status --verbose
bitcat> exit

Alternatively, start just the watcher without interactive mode:

bun run dev:watch

Then in another terminal, test commands:

node dist/main.js login
node dist/main.js track .
node dist/main.js status

Build

For development (unminified, with sourcemaps):

bun run build:dev

For production (minified and obfuscated):

bun run build

Test

bun test

Lint

bun run lint

File Structure

• src/commands/ - CLI command implementations
• src/api/ - API client for BitComplete platform
• src/utils/ - Utility functions for git, storage, and crypto
• scripts/ - Build and API generation scripts

License

This project is published under public access on npm as @bitcomplete/bitcat.