@traisetech/autopilot 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 This project follows [Semantic Versioning](https://semver.org).
 
+## [2.1.0] - 2026-02-08
+
+### Added
+- **Global Configuration**:
+  - Added support for global config via `~/.autopilot/config.json`.
+  - Added `--global` flag to `autopilot config` command.
+  - Implemented config merging (Local > Global > Defaults).
+- **xAI Grok Integration**:
+  - Added Grok as a supported AI provider for commit message generation.
+  - Configurable via `ai.provider: 'grok'` and `grokApiKey`.
+- **Safety**:
+  - Watcher now automatically pauses on push failures to prevent error loops.
+  - Added "Push Failed" state to StateManager.
+- **Leaderboard**:
+  - Implemented accurate focus time calculation by parsing `autopilot.log`.
+  - Fallback to git stats for proxy metrics if logs are missing.
+
+### Fixed
+- **Test Suite**: Resolved cross-test contamination in config tests and watcher integration tests.
+- **Windows Compatibility**: Fixed issues with `process.cwd()` mocking in tests on Windows.
+
+## [2.0.1] - 2026-02-05
+
+### Fixed
+- **Dashboard Stability**: Fixed a crash in `autopilot dashboard` caused by incorrect named import of `getRunningPid`.
+- **Command Reliability**: Added regression tests for `dashboard`, `pause`, `resume`, `stop`, and `status` commands to ensure stability.
+
 ## [2.0.0] - 2026-02-04
 
 ### Added
@@ -26,11 +53,11 @@ This project follows [Semantic Versioning](https://semver.org).
     - `safe-team`: Optimized for collaboration (Team Mode + Secret Checks).
     - `solo-speed`: Optimized for rapid individual development.
     - `strict-ci`: Enforces testing and linting before every commit.
-### Docs/Website
-- Added Leaderboard page with live simulated rankings.
-- Updated homepage Feature Showcase to demonstrate Insights and Safety & Team features.
-- Added Leaderboard to top navigation.
-- Updated Introduction docs to highlight v2.0 features (AI, Focus Engine, Team Mode, Safety Net).
+### Docs/Website
+- Added Leaderboard page with live simulated rankings.
+- Updated homepage Feature Showcase to demonstrate Insights and Safety & Team features.
+- Added Leaderboard to top navigation.
+- Updated Introduction docs to highlight v2.0 features (AI, Focus Engine, Team Mode, Safety Net).
 
 ## [0.1.8] - 2026-02-04
 

package/README.md

@@ -1,215 +1,202 @@
-# 🚀 Autopilot
-
-<div align="center">
-
-![Autopilot Logo](https://img.shields.io/badge/Autopilot-blue?style=for-the-badge&logo=git&logoColor=white)
-
-**Intelligent Git automation that commits and pushes your code, so you can focus on building.**
-
-[![npm version](https://img.shields.io/npm/v/@traisetech/autopilot?style=flat-square&color=success)](https://www.npmjs.com/package/@traisetech/autopilot)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen?style=flat-square)](https://nodejs.org)
-[![Downloads](https://img.shields.io/npm/dm/@traisetech/autopilot?style=flat-square&color=blue)](https://www.npmjs.com/package/@traisetech/autopilot)
-[![GitHub Stars](https://img.shields.io/github/stars/PraiseTechzw/autopilot-cli?style=flat-square&color=gold)](https://github.com/PraiseTechzw/autopilot-cli/stargazers)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/PraiseTechzw/autopilot-cli/ci.yml?style=flat-square)](https://github.com/PraiseTechzw/autopilot-cli/actions)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
-
-**Built by [Praise Masunga](https://github.com/PraiseTechzw) (PraiseTechzw)**
-
-[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [Configuration](#-configuration) • [Commands](#-commands)
-
-</div>
-
----
-
-## 📖 Table of Contents
-
-- [Why Autopilot?](#-why-autopilot)
-- [Features](#-features)
-- [Installation](#-installation)
-- [Quick Start](#-quick-start)
-- [Commands](#-commands)
-- [Configuration](#-configuration)
-- [Safety Features](#-safety-features)
-- [Troubleshooting](#-troubleshooting)
-- [Contributing](#-contributing)
-- [License](#-license)
-
----
-
-## 🎯 Why Autopilot?
-
-Autopilot is designed for developers who want to stay in the flow. It solves manual Git workflow fatigue by handling the repetitive cycle of staging, committing, and pushing changes, allowing you to focus entirely on writing code.
-
-<table>
-<tr>
-<td width="50%">
-
-### ❌ Before Autopilot
-
-```bash
-# Every. Single. Time.
-git add .
-git commit -m "update stuff"
-git push
-
-# Repeat 50+ times a day...
-# Lose focus on coding
-# Forget to commit
-# Inconsistent messages
-```
-
-</td>
-<td width="50%">
-
-### ✅ With Autopilot
-
-```bash
-# One time setup
-autopilot init
-autopilot start
-
-# That's it! 
-# Focus on coding
-# Auto-commits with smart messages
-# Never lose work again
-```
-
-</td>
-</tr>
-</table>
-
----
-
-## ✨ Features
- 
-- **🧠 AI Commit Messages**: Gemini 2.5-powered, context-aware conventional commit messages.
-- **⚡ Watcher Engine**: Real-time file monitoring with smart debouncing using `chokidar`.
-- **🛡️ Safety First**: Blocks commits on protected branches and checks remote status.
-- **🔄 Automated Flow**: Fetches, stages, commits, and pushes (optional) automatically.
-- **👥 Team Mode**: Pull-before-push and conflict abortion with preset workflows.
-- **🖥️ Dashboard**: Real-time terminal dashboard with status and activity feed.
-- **⏮️ Undo System**: Safely rollback the last autopilot commit with one command.
-- **📊 Focus Engine & Insights**: Track active coding time, streaks, peak hours, and commit quality.
-- **⚙️ Zero Config**: Works out of the box, but fully configurable via `.autopilotrc.json`.
-- **🩺 Self-Healing**: Includes a `doctor` command to diagnose and fix issues.
-
+# 🚀 Autopilot
+
+<div align="center">
+
+![Autopilot Logo](https://img.shields.io/badge/Autopilot-blue?style=for-the-badge&logo=git&logoColor=white)
+
+**An intelligent Git automation CLI that safely commits and pushes your code so you can focus on building.**
+
+[![npm version](https://img.shields.io/npm/v/@traisetech/autopilot?style=flat-square&color=success)](https://www.npmjs.com/package/@traisetech/autopilot)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen?style=flat-square)](https://nodejs.org)
+[![Downloads](https://img.shields.io/npm/dm/@traisetech/autopilot?style=flat-square&color=blue)](https://www.npmjs.com/package/@traisetech/autopilot)
+[![GitHub Stars](https://img.shields.io/github/stars/PraiseTechzw/autopilot-cli?style=flat-square&color=gold)](https://github.com/PraiseTechzw/autopilot-cli/stargazers)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/PraiseTechzw/autopilot-cli/ci.yml?style=flat-square)](https://github.com/PraiseTechzw/autopilot-cli/actions)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+**Built by [Praise Masunga](https://github.com/PraiseTechzw) (PraiseTechzw)**
+
+[Features](#-features) • [Installation](#-installation) • [How It Works](#-how-autopilot-works) • [Safety & Guarantees](#-safety--guarantees) • [Commands](#-commands)
+
+</div>
+
+---
+
+## 📖 Table of Contents
+
+- [How Autopilot Works](#-how-autopilot-works)
+- [Safety & Guarantees](#-safety--guarantees)
+- [Failure & Recovery](#-failure--recovery)
+- [AI & Privacy](#-ai--privacy)
+- [Leaderboard & Metrics](#-leaderboard--metrics)
+- [Installation](#-installation)
+- [Quick Start](#-quick-start)
+- [Commands](#-commands)
+- [Configuration](#-configuration)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+---
+
+## 🔍 How Autopilot Works
+
+Autopilot is a local CLI tool that runs in the background of your terminal. It watches your file system for changes and automates the Git workflow based on your configuration.
+
+**No Magic. Just Automation.**
+
+1.  **Watch**: It monitors your project directory for file modifications, creations, and deletions.
+2.  **Wait**: It uses a smart debounce timer (default: 20s) to wait until you stop typing.
+3.  **Check**: It verifies the repository status (branch, remote, conflicts) before acting.
+4.  **Commit**: It stages changes and creates a commit. If AI is enabled, it generates a meaningful message; otherwise, it uses a smart template.
+5.  **Push**: It pushes to your remote repository (optional, enabled by default).
+
+You can stop, pause, or undo Autopilot at any time.
+
+---
+
+## 🛡️ Safety & Guarantees
+
+We prioritize the safety of your code above all else. Autopilot follows strict rules to ensure your work is never lost or corrupted.
+
+### Non-Negotiable Guarantees
+
+-   **Never force-pushes**: Autopilot only performs standard `git push` operations. It will never overwrite remote history.
+-   **Never commits ignored files**: It strictly respects your `.gitignore` and `.autopilotignore` rules.
+-   **Never operates during merge/rebase**: If your repo is in a merge, rebase, or cherry-pick state, Autopilot pauses automatically.
+-   **Never transmits source code without opt-in**: Your code stays local. It is only sent to an AI provider (Gemini/Grok) if you explicitly enable AI features and provide your own API key.
+-   **Pauses when uncertain**: If a git error occurs, a conflict is detected, or the network fails, Autopilot pauses and waits for your intervention.
+-   **Allows all actions to be undone**: The `autopilot undo` command safely reverts the last automated commit without losing your file changes.
+
+---
+
+## ⚠️ Failure & Recovery
+
+What happens when things go wrong? Autopilot is designed to fail safely.
+
+-   **Merge Conflicts**: If a `git pull` results in a conflict, Autopilot aborts the operation and notifies you. It will not attempt to resolve conflicts automatically.
+-   **Network Issues**: If the internet disconnects, Autopilot will queue commits locally and attempt to push when connectivity is restored (if auto-push is enabled).
+-   **Accidental Commits**: If Autopilot commits something you didn't intend, simply run `autopilot undo`. Your files will remain modified in your working directory, but the commit will be removed.
+
+---
+
+## 🤖 AI & Privacy
+
+Autopilot offers **optional** AI integration (Google Gemini or xAI Grok) to generate context-aware commit messages.
+
+-   **Opt-In Only**: AI features are disabled by default. You must enable them and provide your own API key.
+-   **Data Usage**: When enabled, only the `git diff` (text changes) is sent to the AI provider to generate the message.
+-   **Privacy**: Your code is not trained on by Autopilot. We do not store or proxy your code. Interactions are directly between your machine and the AI provider.
+-   **Ranking**: AI usage does not affect your position on the Leaderboard.
+
+---
+
+## 🏆 Leaderboard & Metrics
+
+Autopilot includes a Focus Engine that tracks your local productivity (coding time, commit streaks). You can optionally sync this data to the global Leaderboard.
+
+-   **Participation is Opt-In**: You must explicitly enable syncing with `autopilot config set leaderboard.sync true`.
+-   **Privacy-Safe**: We do not send your email or username directly. IDs are hashed/anonymized.
+-   **No Code Collected**: The leaderboard tracks *metrics* (time, counts), not code. No file contents are ever synced.
+-   **Insight over Competition**: The goal is to help you understand your habits, not to gamify commit spam. Rankings favor consistency and quality.
+
+---
+
+## ⬇️ Installation
+
+Install Autopilot globally using npm:
+
+```bash
+npm install -g @traisetech/autopilot
+```
+
+Or run it directly via npx:
+
+```bash
+npx @traisetech/autopilot start
+```
+
+---
+
+## 🚀 Quick Start
+
+1.  **Navigate to your Git repository:**
+    ```bash
+    cd /path/to/my-project
+    ```
+
+2.  **Initialize Autopilot:**
+    ```bash
+    autopilot init
+    ```
+    Follow the interactive prompts to configure settings (or accept defaults).
+
+3.  **Start the watcher:**
+    ```bash
+    autopilot start
+    ```
+
+    **Autopilot is now running!** It will monitor file changes and automatically commit/push them based on your configuration.
+
+4.  **View the Dashboard:**
+    Open a new terminal and run:
+    ```bash
+    autopilot dashboard
+    ```
+
+---
+
+## 🛠️ Commands
+
+| Command | Description |
+|---------|-------------|
+| `autopilot init` | Initialize configuration in the current repo. |
+| `autopilot start` | Start the watcher process (foreground). |
+| `autopilot stop` | Stop the running watcher process. |
+| `autopilot status` | Check if Autopilot is running. |
+| `autopilot dashboard` | View real-time status and activity UI. |
+| `autopilot undo` | Revert the last Autopilot commit. |
+| `autopilot pause` | Temporarily pause automation. |
+| `autopilot resume` | Resume automation. |
+| `autopilot insights` | View productivity stats and analytics. |
+| `autopilot doctor` | Diagnose configuration and environment issues. |
+
+---
+
+## ⚙️ Configuration
+
+Autopilot uses an `.autopilotrc.json` file in your project root.
+
+```json
+{
+  "debounceSeconds": 20,
+  "minSecondsBetweenCommits": 180,
+  "autoPush": true,
+  "blockBranches": ["main", "master"],
+  "teamMode": true,
+  "preventSecrets": true,
+  "ai": {
+    "enabled": true,
+    "provider": "gemini"
+  }
+}
+```
+
+See [docs/CONFIGURATION.md](docs/CONFIGURATION.md) for full details.
+
 ---
- 
-## 🆕 What's New in v2.0
- 
-- AI commit generation via Google Gemini (opt-in, with graceful fallback).
-- Team presets (`safe-team`, `solo-speed`, `strict-ci`) for different workflows.
-- Safety net with `autopilot undo`, secret detection, and large-file prevention.
-- Productivity Focus Engine with `autopilot insights` and CSV export.
-
----
-
-## ⬇️ Installation
-
-Install Autopilot globally using npm:
-
-```bash
-npm install -g @traisetech/autopilot
-```
-
-Or run it directly via npx:
-
-```bash
-npx @traisetech/autopilot start
-```
-
----
-
-## 🚀 Quick Start
-
-1. **Navigate to your Git repository:**
-   ```bash
-   cd /path/to/my-project
-   ```
-
-2. **Initialize Autopilot:**
-   ```bash
-   autopilot init
-   ```
-   Follow the interactive prompts to configure settings (or accept defaults).
-
-3. **Start the watcher:**
-   ```bash
-   autopilot start
-   ```
-
-   **Autopilot is now running!** It will monitor file changes and automatically commit/push them based on your configuration.
-
-4. **View the Dashboard (New):**
-   Open a new terminal and run:
-   ```bash
-   autopilot dashboard
-   ```
-
----
-
-## 🛠️ Commands
-
-| Command | Description |
-|---------|-------------|
-| `autopilot init` | Initialize configuration in the current repo. |
-| `autopilot start` | Start the watcher process (foreground). |
-| `autopilot stop` | Stop the running watcher process. |
-| `autopilot status` | Check if Autopilot is running. |
-| `autopilot dashboard` | View real-time status and activity UI. |
-| `autopilot undo` | Revert the last Autopilot commit. |
-| `autopilot pause [reason]` | Temporarily pause automation. |
-| `autopilot resume` | Resume automation. |
-| `autopilot insights` | View productivity stats and analytics. |
-| `autopilot doctor` | Diagnose configuration and environment issues. |
-
----
-
-## ⚙️ Configuration
-
-Autopilot uses an `.autopilotrc.json` file in your project root.
-
-```json
-{
-  "debounceSeconds": 20,
-  "minSecondsBetweenCommits": 180,
-  "autoPush": true,
-  "blockBranches": ["main", "master"],
-  "teamMode": true,
-  "preventSecrets": true,
-  "maxFileSizeMB": 50
-}
-```
-
-See [docs/CONFIGURATION.md](docs/CONFIGURATION.md) for full details.
-
----
-
-## 🛡️ Safety Features
-
-Autopilot includes multiple layers of protection:
-
-1. **Branch Protection**: Prevents running on blocked branches (default: `main`, `master`).
-2. **Secret Detection**: Scans for AWS keys, GitHub tokens, and other secrets before committing.
-3. **File Size Limits**: Prevents committing accidental large files (>50MB).
-4. **Team Mode**: Ensures local changes are rebased on top of remote changes to prevent conflicts.
-5. **Undo**: Allows quick recovery from unwanted auto-commits.
-
----
-
-## 🤝 Contributing
-
-We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
-
-1. Fork the repo
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
----
-
-## 📄 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+1.  Fork the repo
+2.  Create a feature branch (`git checkout -b feature/amazing-feature`)
+3.  Commit your changes (`git commit -m 'feat: add amazing feature'`)
+4.  Push to the branch (`git push origin feature/amazing-feature`)
+5.  Open a Pull Request
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/bin/autopilot.js

@@ -12,6 +12,7 @@ const { insights } = require('../src/commands/insights');
 const { leaderboard } = require('../src/commands/leaderboard');
 const doctor = require('../src/commands/doctor');
 const presetCommand = require('../src/commands/preset');
+const configCommand = require('../src/commands/config');
 const pkg = require('../package.json');
 const logger = require('../src/utils/logger');
 const { checkForUpdate } = require('../src/utils/update-check');
@@ -28,7 +29,8 @@ const commands = {
   insights: insights,
   leaderboard: leaderboard,
   doctor: doctor,
-  preset: presetCommand
+  preset: presetCommand,
+  config: configCommand
 };
 
 // Runtime assertion to prevent wiring errors
@@ -114,6 +116,12 @@ program
   .description('Manage workflow presets (list, apply)')
   .action(presetCommand);
 
+program
+  .command('config [action] [key] [value]')
+  .description('Manage configuration (list, get, set)')
+  .option('-g, --global', 'Use global configuration')
+  .action(configCommand);
+
 program
   .command('doctor')
   .description('Diagnose and validate autopilot setup')

package/docs/DESIGN_PRINCIPLES.md

@@ -0,0 +1,58 @@
+# Autopilot CLI – System / Design Prompt
+
+This document serves as the design + behavior contract for Autopilot CLI. It guides internal logic, AI integrations, future contributors, and decision-making.
+
+## Core Principles
+
+- **Autopilot CLI is a local-first, developer-trust-first Git automation tool.**
+- Its primary goal is to reduce Git friction without reducing developer control.
+- The tool must always prioritize **safety, predictability, and transparency** over convenience.
+- Autopilot automates repetitive Git tasks, not developer intent.
+- Autopilot must never surprise the user.
+- Autopilot must fail loudly, pause safely, and never guess during ambiguity.
+
+## Hard Guarantees (Non-Negotiable)
+
+Autopilot will **never**:
+
+- force-push
+- commit ignored files
+- commit `.env`, secrets, or sensitive files
+- operate during merge or rebase states
+- send source code externally without explicit opt-in
+
+All automation is **reversible** via `autopilot undo`.
+
+## Failure Behavior
+
+- If a **push fails** → pause watcher, notify user.
+- If **authentication expires** → pause watcher.
+- If **merge conflicts** are detected → stop automation.
+- If **network is unavailable** → queue safely or pause.
+- If **repository state is ambiguous** → do nothing.
+
+## Commit Intelligence
+
+- Commit messages must:
+  - be deterministic and explainable
+  - reflect file-level changes
+  - follow conventional commit standards when possible
+- **AI (Gemini / Grok)** is an assistant, never an authority.
+- AI output must be reviewable, overridable, and optional.
+
+## Leaderboard & Metrics
+
+- Metrics are derived **only** from local Git activity created by Autopilot.
+- **No raw code, diffs, or file contents are ever transmitted.**
+- Leaderboard data is:
+  - opt-in
+  - anonymized or pseudonymous
+  - explainable (users know exactly what is counted)
+
+## Philosophy
+
+- Autopilot exists to protect developer flow, not replace developer judgment.
+- **When in doubt: pause, explain, wait.**
+
+---
+*Any feature (including Grok or leaderboards) must pass this test.*