bashio 0.4.1 → 0.5.0

package/README.md

@@ -1,8 +1,16 @@
 # Bashio
 
-> **Natural language to shell commands. Stop Googling, start doing.**
+> Natural language to shell commands. Stop Googling, start doing.
 
-Bashio is an AI-powered CLI tool that translates your everyday language into precise shell commands. Just describe what you want to do, and let AI handle the syntax.
+```bash
+npm i -g bashio
+```
+
+---
+
+## What is Bashio?
+
+Bashio is an AI-powered CLI tool that converts plain English into shell commands. Instead of searching for the right syntax, just describe what you want to do.
 
 ```bash
 $ b find all files larger than 100mb and delete them
@@ -10,432 +18,215 @@ $ b find all files larger than 100mb and delete them
 ```
   > find . -size +100M -type f -delete
 
-  ? Execute? (y/n/e/c/edit) 
+  ? Execute? (y/n/e/c/edit)
 ```
 
----
-
-## Features
-
-- **Natural Language Commands** - Describe tasks in plain English, get executable shell commands
-- **Multiple AI Providers** - Choose from Claude, OpenAI, Ollama (local/free), or OpenRouter
-- **Custom Shortcuts** - Create reusable command templates with dynamic placeholders
-- **Safe Execution** - Review and confirm every command before it runs
-- **Dangerous Command Detection** - Extra warnings for potentially destructive operations
-- **Explain Mode** - Understand what any command does before executing
-- **Command History** - Track all generated commands with usage statistics
-- **Smart Suggestions** - Get shortcut recommendations based on your usage patterns
-- **Privacy First** - All data stored locally in `~/.bashio/`, never sent to external servers
+You review the command, then choose to execute, edit, or cancel. Simple.
 
 ---
 
-## Installation
-
-### Prerequisites
+## Getting Started
 
-- Node.js 20.12.0 or higher
-- pnpm (recommended) or npm
-
-### Setup
+### 1. Install
 
 ```bash
-# Clone the repository
-git clone https://github.com/VrandaaGarg/bashio.git
-cd bashio
+npm i -g bashio
+```
 
-# Install dependencies
-pnpm install
+Requires Node.js 20.12.0 or higher.
 
-# Build the project
-pnpm build
+### 2. Setup your AI provider
 
-# Link globally to use 'b' command anywhere
-pnpm link --global
+```bash
+b --auth
 ```
 
-### Quick Start
+Choose from Claude, OpenAI, Ollama (free/local), or OpenRouter.
 
-```bash
-# 1. Configure your AI provider
-b --auth
+### 3. Start using it
 
-# 2. Start using natural language commands
-b find all png files in current directory
+```bash
+b show disk usage sorted by size
 ```
 
----
-
-## Usage
+That's it. You're ready to go.
 
-### Natural Language Commands
+---
 
-Simply prefix your request with `b` and describe what you want:
+## Examples
 
 ```bash
 # File operations
 b find all javascript files modified today
 b delete all node_modules folders recursively
-b count lines of code in all typescript files
-b compress all images in this folder
+b compress all png images in this folder
 
-# Git operations
-b undo the last commit but keep changes
-b show commits from last week by author john
-b create a new branch called feature/auth
+# Git
+b undo last commit but keep changes
+b show commits from last week by john
 
-# System operations
-b show disk usage sorted by size
-b what is my public ip address
+# System
 b kill whatever is running on port 3000
+b what is my public ip address
 b list all running docker containers
 
-# Network operations
-b download this file and save as data.json
-b check if google.com is reachable
+# Network
+b download this url and save as data.json
 ```
 
-### Confirmation Options
+---
+
+## Confirmation Options
 
-When a command is generated, you have several options:
+When a command is generated, you can:
 
-| Input | Action |
-|-------|--------|
-| `y` or `Enter` | Execute the command |
-| `n` | Cancel and exit |
-| `e` | Explain what the command does (AI-powered) |
-| `c` | Copy command to clipboard |
-| `edit` | Edit the command before executing |
+| Key | Action |
+|-----|--------|
+| `y` or Enter | Execute the command |
+| `n` | Cancel |
+| `e` | Explain what the command does |
+| `c` | Copy to clipboard |
+| `edit` | Edit the command before running |
 
 ---
 
 ## Shortcuts
 
-Create reusable command templates for frequently used operations.
+Save commands you use frequently as shortcuts with placeholders.
 
-### Creating Shortcuts
+### Create a shortcut
 
 ```bash
-# Interactive mode
+# Interactive
 b --add-shortcut
 
-# One-liner with placeholders
+# One-liner
 b --add-shortcut killport "lsof -ti:{{port}} | xargs kill -9" port
-
-# Multi-argument shortcut
-b --add-shortcut deploy "git push {{remote}} {{branch}}" remote branch
 ```
 
-### Using Shortcuts
+### Use it
 
 ```bash
-# Single argument - all remaining text becomes the argument
 b killport 3000
-
-# Output:
-#   [shortcut: killport]
-#   > lsof -ti:3000 | xargs kill -9
-#   ? Execute? (y/n/e/c/edit)
-
-# Multi-word single argument (great for commit messages)
-b commit "Add user authentication feature"
 ```
-
-### Managing Shortcuts
-
-```bash
-b --shortcuts           # List all shortcuts
-b --edit-shortcuts      # Edit shortcuts in your default editor
-b --remove-shortcut killport  # Remove a specific shortcut
 ```
+  [shortcut: killport]
+  > lsof -ti:3000 | xargs kill -9
 
-### Placeholder Syntax
+  ? Execute? (y/n/e/c/edit)
+```
 
-Use `{{name}}` for dynamic arguments:
+### Manage shortcuts
 
 ```bash
-# Template: "docker exec -it {{container}} {{cmd}}"
-# Args: container, cmd
-
-b dockerrun myapp bash
-# Expands to: docker exec -it myapp bash
+b --shortcuts              # List all
+b --edit-shortcuts         # Edit in your editor
+b --remove-shortcut name   # Delete one
 ```
 
 ---
 
 ## AI Providers
 
-Bashio supports multiple AI providers. Configure with `b --auth`:
-
-| Provider | Auth Method | Cost | Best For |
-|----------|-------------|------|----------|
-| **Claude** (Anthropic) | API Key | Paid | Best accuracy, complex commands |
-| **OpenAI** (ChatGPT) | API Key | Paid | Great all-rounder |
-| **Ollama** | Local | Free | Privacy, offline usage |
-| **OpenRouter** | API Key | Pay-per-use | Access to multiple models |
-
-### Available Models
-
-#### Claude (Anthropic)
-- `claude-sonnet-4-20250514` - Claude Sonnet 4 (recommended)
-- `claude-3-5-sonnet-20241022` - Claude 3.5 Sonnet
-- `claude-3-5-haiku-20241022` - Claude 3.5 Haiku (fast)
-
-#### OpenAI
-- `gpt-4o` - GPT-4o (recommended)
-- `gpt-4o-mini` - GPT-4o Mini (fast)
-- `gpt-4-turbo` - GPT-4 Turbo
+Configure with `b --auth`. Supported providers:
 
-#### OpenRouter
-- `anthropic/claude-sonnet-4` - Claude Sonnet 4
-- `anthropic/claude-3.5-sonnet` - Claude 3.5 Sonnet
-- `openai/gpt-4o` - GPT-4o
-- `google/gemini-pro-1.5` - Gemini Pro 1.5
-- `meta-llama/llama-3.1-70b-instruct` - Llama 3.1 70B
+| Provider | Cost | Notes |
+|----------|------|-------|
+| **Claude** (Anthropic) | Paid | Best accuracy |
+| **OpenAI** (ChatGPT) | Paid | Great all-rounder |
+| **Ollama** | Free | Runs locally, offline |
+| **OpenRouter** | Pay-per-use | Access to multiple models |
 
-#### Ollama (Local)
-Any model installed on your machine:
-- `llama3.2`, `llama3.1`, `codellama`, `mistral`, `gemma2`, etc.
-
-### Switching Models
+Switch models anytime:
 
 ```bash
-b --model    # Interactive model selection
+b --model
 ```
 
 ---
 
-## History & Statistics
-
-Bashio tracks your command history for insights and suggestions.
+## History & Stats
 
-### View History
+Bashio tracks your command history locally.
 
 ```bash
-b --history              # Show recent command history
-b --history --search git # Search history for specific terms
-```
-
-### Usage Statistics
-
-```bash
-b --stats
-```
-
-```
-  Bashio Usage Statistics
-
-  Overview
-  ┌──────────────────────┬───────────────┐
-  │ Metric               │         Value │
-  ├──────────────────────┼───────────────┤
-  │ Commands Generated   │           156 │
-  │ Executed             │     142 (91%) │
-  │ Today                │            12 │
-  │ This Week            │            45 │
-  └──────────────────────┴───────────────┘
-
-  Most Used Commands
-  ┌───┬─────────────────────────────────┬──────┬──────────┐
-  │ # │ Command                         │ Uses │   Source │
-  ├───┼─────────────────────────────────┼──────┼──────────┤
-  │ 1 │ lsof -ti:3000 | xargs kill -9   │   23 │ shortcut │
-  │ 2 │ git status                      │   18 │       ai │
-  │ 3 │ docker ps -a                    │   15 │       ai │
-  └───┴─────────────────────────────────┴──────┴──────────┘
-```
-
-### Smart Shortcut Suggestions
-
-Based on your usage patterns, Bashio suggests commands to save as shortcuts:
-
-```bash
-b --suggest-shortcuts
-```
-
-### Clear History
-
-```bash
-b --clear-history        # Clear all history
+b --history              # View recent commands
+b --history --search git # Search history
+b --stats                # Usage statistics
+b --suggest-shortcuts    # Get shortcut suggestions based on usage
+b --clear-history        # Clear history
 ```
 
 ---
 
-## Configuration
-
-All configuration is stored locally at `~/.bashio/`:
-
-```
-~/.bashio/
-├── config.json      # Provider settings and preferences
-├── shortcuts.json   # Custom shortcuts
-└── history.db       # Command history (SQLite)
-```
-
-### Settings
-
-The `config.json` file contains customizable settings:
-
-```json
-{
-  "version": 1,
-  "provider": "claude",
-  "model": "claude-sonnet-4-20250514",
-  "credentials": {
-    "type": "api_key",
-    "apiKey": "sk-ant-..."
-  },
-  "settings": {
-    "confirmBeforeExecute": true,
-    "historyEnabled": true,
-    "historyRetentionDays": 30,
-    "historyMaxEntries": 2000,
-    "autoConfirmShortcuts": false
-  }
-}
-```
-
-#### Available Settings
+## Safety
 
-| Setting | Type | Default | Description |
-|---------|------|---------|-------------|
-| `confirmBeforeExecute` | boolean | `true` | Require confirmation before running commands |
-| `historyEnabled` | boolean | `true` | Track command history |
-| `historyRetentionDays` | number | `30` | Days to keep history before auto-cleanup |
-| `historyMaxEntries` | number | `2000` | Maximum history entries to retain |
-| `autoConfirmShortcuts` | boolean | `false` | Skip confirmation for shortcut commands |
+Bashio detects dangerous commands (like `rm -rf`) and shows extra warnings:
 
-### View Current Configuration
-
-```bash
-b --config
 ```
-
----
-
-## CLI Reference
-
-### Core Commands
-
-| Command | Description |
-|---------|-------------|
-| `b <query>` | Convert natural language to shell command |
-| `b <shortcut> [args]` | Execute a saved shortcut |
-
-### Configuration
-
-| Command | Description |
-|---------|-------------|
-| `b --auth` | Configure AI provider and credentials |
-| `b --config` | View current configuration |
-| `b --model` | Change the AI model |
-
-### Shortcuts Management
-
-| Command | Description |
-|---------|-------------|
-| `b --shortcuts` | List all saved shortcuts |
-| `b --add-shortcut` | Create a new shortcut (interactive) |
-| `b --add-shortcut <name> <template> [args...]` | Create shortcut (one-liner) |
-| `b --edit-shortcuts` | Edit shortcuts in default editor |
-| `b --remove-shortcut <name>` | Delete a shortcut |
-
-### History & Analytics
-
-| Command | Description |
-|---------|-------------|
-| `b --history` | View command history |
-| `b --stats` | View usage statistics |
-| `b --clear-history` | Clear command history |
-| `b --suggest-shortcuts` | Get shortcut suggestions based on usage |
-
-### Help
-
-| Command | Description |
-|---------|-------------|
-| `b --help` | Show help information |
-| `b --version` | Show version number |
-
----
-
-## Safety Features
-
-### Dangerous Command Detection
-
-Bashio automatically detects potentially dangerous operations and requires explicit confirmation:
-
-- Recursive deletions (`rm -rf`)
-- System-wide operations (`sudo`, root access)
-- Force operations (`--force`, `-f` flags)
-- Disk operations (formatting, partitioning)
-
-```bash
-$ b delete everything in the home directory
-
   > rm -rf ~/*
 
   WARNING: This command may cause irreversible changes.
-
   Reasons:
   - Uses recursive force delete (rm -rf)
   - Targets home directory
 
-  ? Proceed with this command? (y/N)
+  ? Proceed? (y/N)
 ```
 
-### Confirmation by Default
-
-Every command requires confirmation before execution. You always see exactly what will run.
+Every command requires confirmation before execution.
 
 ---
 
-## Development
+## All Commands
 
-```bash
-# Install dependencies
-pnpm install
-
-# Development mode (watch for changes)
-pnpm dev
+| Command | Description |
+|---------|-------------|
+| `b <query>` | Convert natural language to command |
+| `b <shortcut> [args]` | Run a saved shortcut |
+| `b --auth` | Setup AI provider |
+| `b --model` | Change AI model |
+| `b --config` | View current config |
+| `b --shortcuts` | List shortcuts |
+| `b --add-shortcut` | Create shortcut |
+| `b --remove-shortcut <name>` | Delete shortcut |
+| `b --edit-shortcuts` | Edit shortcuts file |
+| `b --history` | View command history |
+| `b --stats` | Usage statistics |
+| `b --suggest-shortcuts` | Get shortcut suggestions |
+| `b --clear-history` | Clear history |
+| `b --help` | Show help |
+| `b --version` | Show version |
 
-# Build for production
-pnpm build
+---
 
-# Run linter
-pnpm lint:check
+## Configuration
 
-# Fix lint issues
-pnpm lint
+All data is stored locally at `~/.bashio/`:
 
-# Type check
-pnpm typecheck
+```
+~/.bashio/
+├── config.json      # Settings and API keys
+├── shortcuts.json   # Your shortcuts
+└── history.db       # Command history
 ```
 
-### Tech Stack
+View your config:
 
-- **Runtime**: Node.js 22+, TypeScript 5.9
-- **CLI Framework**: Clipanion
-- **Database**: better-sqlite3 (SQLite)
-- **Validation**: Zod
-- **UI**: picocolors, ora, @inquirer/prompts
-- **Build**: tsup, Biome
+```bash
+b --config
+```
 
 ---
 
-## Privacy & Security
+## Privacy
 
-- **Local Storage**: All data (config, history, shortcuts) stays on your machine
-- **No Telemetry**: No usage data is collected or sent anywhere
-- **Secure Credentials**: API keys stored with restricted file permissions (0600)
-- **Your Queries**: Only sent to your chosen AI provider for command generation
+- All data stays on your machine
+- No telemetry or tracking
+- Queries only sent to your chosen AI provider
 
 ---
 
 ## License
 
 MIT
-
----
-
-<p align="center">
-  <sub>Built with frustration from Googling the same commands over and over.</sub>
-</p>

package/dist/index.js

@@ -2,6 +2,7 @@
 
 // src/cli/index.ts
 import { Builtins, Cli } from "clipanion";
+import updateNotifier from "update-notifier";
 
 // src/core/config.ts
 import {
@@ -2470,6 +2471,26 @@ var SuggestShortcutsCommand = class extends Command12 {
 };
 
 // src/cli/index.ts
+var pkg = {
+  name: "bashio",
+  version: "0.5.0"
+};
+var notifier = updateNotifier({
+  pkg,
+  updateCheckInterval: 1e3 * 60 * 60 * 24
+  // 1 day
+});
+notifier.notify({
+  message: "Bashio update available: {currentVersion} \u2192 {latestVersion}\nRun: {updateCommand}",
+  boxenOptions: {
+    padding: 1,
+    margin: 1,
+    borderStyle: "round",
+    borderColor: "cyan",
+    title: "\u2728 Update Available",
+    titleAlignment: "center"
+  }
+});
 initDatabase();
 if (shouldRunCleanup()) {
   const config = loadConfig();
@@ -2480,7 +2501,7 @@ if (shouldRunCleanup()) {
 var cli = new Cli({
   binaryLabel: "Bashio",
   binaryName: "b",
-  binaryVersion: "0.4.0"
+  binaryVersion: pkg.version
 });
 cli.register(DefaultCommand);
 cli.register(AuthCommand);