@brainfile/cli 0.1.0 → 0.1.3

package/README.md

@@ -4,19 +4,68 @@ Command-line interface for Brainfile task management. Manage your tasks from the
 
 ## Installation
 
+### Install Globally (Recommended)
+
+Install the CLI globally to use the `brainfile` command anywhere:
+
 ```bash
 npm install -g @brainfile/cli
 ```
 
-Or use directly from the repo:
+After installation, verify it works:
 
 ```bash
-cd packages/brainfile-cli
-npm install
-npm run build
-node dist/cli.js --help
+brainfile --version
+brainfile --help
 ```
 
+### Install as Project Dependency
+
+For project-specific usage:
+
+```bash
+npm install --save-dev @brainfile/cli
+```
+
+Then use via npm scripts or npx:
+
+```bash
+npx brainfile list
+```
+
+### Using npx (No Installation)
+
+Run commands without installing:
+
+```bash
+npx @brainfile/cli list
+npx @brainfile/cli add --title "New task"
+```
+
+## Quick Start
+
+1. **Install the CLI:**
+   ```bash
+   npm install -g @brainfile/cli
+   ```
+
+2. **Create a brainfile.md** in your project (or use an existing one)
+
+3. **List your tasks:**
+   ```bash
+   brainfile list
+   ```
+
+4. **Add a new task:**
+   ```bash
+   brainfile add --title "My first task" --priority high
+   ```
+
+5. **Move a task:**
+   ```bash
+   brainfile move --task task-123 --column done
+   ```
+
 ## Usage
 
 ### List Tasks
@@ -235,41 +284,49 @@ Task IDs are automatically generated with a timestamp and random string to ensur
 - Task completion tracking
 - Subtask management
 
-## Development
+## Package Information
+
+- **Package**: `@brainfile/cli`
+- **npm**: https://www.npmjs.com/package/@brainfile/cli
+- **Repository**: https://github.com/brainfile/cli
+- **Core Library**: Built on [@brainfile/core](https://www.npmjs.com/package/@brainfile/core)
 
-### Using Make (Recommended)
+## Development
 
-From the project root:
+### Setup
 
 ```bash
-# Build the CLI (includes core library)
-make build-cli
+# Clone the repository
+git clone https://github.com/brainfile/cli.git
+cd cli
 
-# Run the CLI with automatic build (fast dev shortcut)
-make cli ARGS="list --file brainfile.md"
-make cli ARGS="add --title 'New task' --priority high"
-make cli ARGS="--help"
+# Install dependencies
+npm install
+
+# Build
+npm run build
 
-# Create standalone binaries for distribution
-make build-cli-bin
+# Run tests
+npm test
 
-# Clean all build artifacts
-make clean
+# Watch mode for development
+npm run dev
 ```
 
-### Using npm directly
-
-From the `packages/brainfile-cli` directory:
+### Testing Locally
 
 ```bash
-# Install dependencies
-npm install
-
-# Build
+# Build the CLI
 npm run build
 
-# Watch mode
-npm run dev
+# Link globally for local testing
+npm link
+
+# Now you can use it anywhere
+brainfile --help
+
+# Unlink when done
+npm unlink -g @brainfile/cli
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brainfile/cli",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Command-line interface for Brainfile task management",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,8 +15,7 @@
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "prepublishOnly": "npm run build",
-    "prepack": "npm run build",
-    "version": "npm run build && git add -A dist"
+    "prepack": "npm run build"
   },
   "keywords": [
     "brainfile",
@@ -28,8 +27,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/brainfile/brainfile",
-    "directory": "cli"
+    "url": "https://github.com/brainfile/cli"
   },
   "publishConfig": {
     "access": "public"