bugit-cli 1.0.1 → 1.0.2

package/README.md

@@ -6,78 +6,270 @@ Log bugs from your terminal without breaking your flow.
 npm install -g bugit-cli
 ```
 
-## Authentication
+Then authenticate:
 
 ```bash
-bug login     # opens a browser tab to authenticate
-bug whoami    # show your email and API endpoint
-bug logout    # clear stored credentials
+bug login
 ```
 
+---
+
+## Quick start
+
+```bash
+bug login                          # authenticate via browser
+bug log "Login crashes on Safari"  # log a bug
+bug list                           # see your bugs
+bug view <id>                      # inspect a bug
+```
+
+---
+
+## Help
+
+Every command has built-in help:
+
+```bash
+bug --help          # list all commands and global options
+bug help <command>  # detailed help for a specific command
+```
+
+---
+
 ## Commands
 
-### Log a bug
+### `bug login`
+
+Authenticate via browser-based device flow. Opens a browser tab for you to approve the CLI session. Token is stored in `~/.buglogrc`.
+
+```
+USAGE
+  bug login
+```
+
+```bash
+bug login     # opens browser → approve in dashboard → CLI is authenticated
+```
+
+### `bug logout`
+
+Remove stored credentials.
+
+```
+USAGE
+  bug logout
+```
+
+```bash
+bug logout  # clears token from ~/.buglogrc
+```
+
+### `bug whoami`
+
+Show the authenticated email and API endpoint.
+
+```
+USAGE
+  bug whoami
+```
+
+```bash
+bug whoami
+# you@email.com → https://bugit-j70c.onrender.com
+```
+
+### `bug log <title>`
+
+Log a new bug.
+
+```
+USAGE
+  bug log <title> [options]
+
+ARGUMENTS
+  title                 Bug title (required)
+
+OPTIONS
+  -s, --sev <level>     Severity: low | medium | high | critical   (default: medium)
+  -p, --project <name>  Project name
+  -e, --env <env>       Environment: local | staging | prod
+  -d, --desc <text>     Description or steps to reproduce
+  -n, --notes <text>    Root cause or fix notes
+  -t, --tags <tags>     Comma-separated tags
+```
 
 ```bash
 bug log "Login crashes on Safari 17"
 bug log "Checkout 500 on mobile" -s critical -p storefront -e prod
 bug log "Slow query on reports page" -s medium -p api -t postgres,performance
-bug log "Build failing" -s high --desc "Error: cannot find module 'react'"
+bug log "Build failing" -s high --desc "error: cannot find module 'react'"
 ```
 
-**Options**
+### `bug pipe <title>`
 
-| Flag | Description | Default |
-|------|-------------|---------|
-| `-s, --sev` | `low` \| `medium` \| `high` \| `critical` | `medium` |
-| `-p, --project` | Project name | |
-| `-e, --env` | `local` \| `staging` \| `prod` | |
-| `-d, --desc` | Description or steps to reproduce | |
-| `-n, --notes` | Root cause or fix notes | |
-| `-t, --tags` | Comma-separated tags | |
+Pipe stdin into a bug description. Captures build errors, stack traces, and log output.
 
-### Pipe from stdin
+```
+USAGE
+  bug pipe <title> [options]
 
-Pipe build errors, stack traces, or any output directly into a bug.
+ARGUMENTS
+  title                 Bug title (required)
+
+OPTIONS
+  -s, --sev <level>     Severity: low | medium | high | critical   (default: high)
+  -p, --project <name>  Project name
+  -e, --env <env>       Environment: local | staging | prod
+  -t, --tags <tags>     Comma-separated tags
+```
 
 ```bash
 npm run build 2>&1 | bug pipe "Build failed" -s high -p myapp
 cat error.log | bug pipe "Server crash" -s critical -e prod
+kubectl logs pod-web-1 2>&1 | bug pipe "Pod crash loop" -p infra -t kubernetes
 ```
 
-### List bugs
+### `bug list`
+
+List bugs with optional filters.
+
+```
+USAGE
+  bug list [options]
+
+OPTIONS
+  -p, --project <name>  Filter by project
+  --status <status>     Filter by status: open | in-progress | resolved | wontfix
+  --sev <level>         Filter by severity: low | medium | high | critical
+  --limit <n>           Number of results   (default: 20)
+```
 
 ```bash
-bug list                        # all bugs, last 20
+bug list
 bug list --status open
 bug list --sev critical
 bug list -p myapp --limit 50
+bug list -p api --status in-progress --sev high
+```
+
+### `bug view <id>`
+
+View full bug details including description, notes, metadata, and comments. Accepts a full ObjectId or 6-character short ID.
+
 ```
+USAGE
+  bug view <id>
 
-### View a bug
+ARGUMENTS
+  id  Full ObjectId or 6-character short ID
+```
 
 ```bash
-bug view <id>                   # accepts full ID or short 6-char ID
+bug view abc123
 ```
 
-### Update a bug
+### `bug update <id>`
+
+Update a bug's fields.
+
+```
+USAGE
+  bug update <id> [options]
+
+ARGUMENTS
+  id  Full ObjectId or 6-character short ID
+
+OPTIONS
+  --status <status>     New status: open | in-progress | resolved | wontfix
+  --sev <level>         New severity: low | medium | high | critical
+  --notes <text>        Replace notes
+  --tags <tags>         Replace tags (comma-separated)
+```
 
 ```bash
-bug update <id> --status in-progress
-bug update <id> --sev critical --notes "narrowed to auth middleware"
-bug update <id> --tags nestjs,redis
+bug update abc123 --status in-progress
+bug update abc123 --sev critical --notes "narrowed to auth middleware"
+bug update abc123 --tags nestjs,redis,queue
 ```
 
-### Shortcuts
+### `bug resolve <id>`
+
+Shortcut to mark a bug as resolved.
+
+```
+USAGE
+  bug resolve <id>
+```
 
 ```bash
-bug resolve <id>    # set status to resolved
-bug wontfix <id>    # set status to wontfix
+bug resolve abc123
 ```
 
+### `bug wontfix <id>`
+
+Shortcut to mark a bug as won't fix.
+
+```
+USAGE
+  bug wontfix <id>
+```
+
+```bash
+bug wontfix abc123
+```
+
+---
+
+## All options reference
+
+| Flag | Long | Commands | Description |
+|------|------|----------|-------------|
+| `-p` | `--project <name>` | log, pipe, list | Project name |
+| `-s` | `--sev <level>` | log, pipe, list | Severity |
+| `-e` | `--env <env>` | log, pipe | Environment |
+| `-d` | `--desc <text>` | log | Description |
+| `-n` | `--notes <text>` | log, update | Notes |
+| `-t` | `--tags <tags>` | log, pipe, update | Comma-separated tags |
+| | `--status <status>` | list, update | Status filter or value |
+| | `--limit <n>` | list | Max results |
+
+---
+
+## Environment variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `BUGIT_API_URL` | `https://bugit-j70c.onrender.com` | API endpoint |
+
+---
+
+## Real-world workflows
+
+```bash
+# Catch a failing build
+npm run build 2>&1 | bug pipe "Build failed" -s high -p webapp
+
+# Log a production incident from a log file
+ssh prod tail -100 /var/log/app/error.log | bug pipe "Prod 500s" -s critical -e prod
+
+# Triage your open bugs
+bug list --status open --sev critical
+
+# Investigate and update
+bug view a1b2c3
+bug update a1b2c3 --status in-progress --notes "looking into it"
+
+# Mark resolved after deploy
+bug resolve a1b2c3
+```
+
+---
+
 ## Web dashboard
 
-Review, filter, and comment on bugs at [https://bugit-dev.vercel.app](https://bugit-dev.vercel.app).
+Review, filter, and comment on bugs at [bugit-dev.vercel.app](https://bugit-dev.vercel.app).
+
+---
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bugit-cli",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "BugIt CLI - capture bugs from your terminal",
   "author": "Golden Azubuike <goldenazubuike@gmail.com>",
   "license": "MIT",

package/src/api.js

@@ -27,7 +27,7 @@ export async function apiFetch(path, options = {}) {
     clearTimeout(timer);
 
     if (res.status === 401) {
-      throw new ApiError('Not authenticated — run: bug login', 401);
+      throw new ApiError('Not authenticated - run: bug login', 401);
     }
     if (!res.ok) {
       let msg = `HTTP ${res.status}`;
@@ -39,7 +39,7 @@ export async function apiFetch(path, options = {}) {
   } catch (err) {
     clearTimeout(timer);
     if (err.name === 'AbortError') {
-      throw new ApiError('API unreachable — is the BugIt server running?', 0);
+      throw new ApiError('API unreachable - is the BugIt server running?', 0);
     }
     if (err instanceof ApiError) throw err;
     throw new ApiError(`Network error: ${err.message}`, 0);

package/src/format.js

@@ -65,12 +65,12 @@ export function printBugDetail(bug, comments = []) {
   console.log(chalk.bold(bug.title));
   console.log(line);
   console.log(`${chalk.dim('ID')}          ${shortId(bug._id)} (${bug._id})`);
-  console.log(`${chalk.dim('Project')}     ${bug.project || '—'}`);
+  console.log(`${chalk.dim('Project')}     ${bug.project || '-'}`);
   console.log(`${chalk.dim('Severity')}    ${colorSev(bug.severity)}`);
   console.log(`${chalk.dim('Status')}      ${colorStatus(bug.status)}`);
-  console.log(`${chalk.dim('Environment')} ${bug.environment || '—'}`);
+  console.log(`${chalk.dim('Environment')} ${bug.environment || '-'}`);
   console.log(`${chalk.dim('Source')}      ${bug.source}`);
-  console.log(`${chalk.dim('Tags')}        ${bug.tags?.join(', ') || '—'}`);
+  console.log(`${chalk.dim('Tags')}        ${bug.tags?.join(', ') || '-'}`);
   console.log(
     `${chalk.dim('Created')}     ${new Date(bug.createdAt).toLocaleString()}`,
   );

package/src/index.js

@@ -16,7 +16,7 @@ function handleError(err) {
   process.exit(1);
 }
 
-program.name('bug').description('BugIt CLI — log and review bugs fast').version('1.0.0');
+program.name('bug').description('BugIt CLI - log and review bugs fast').version('1.0.0');
 
 // bug log
 program
@@ -44,7 +44,7 @@ program
       };
       const bug = await apiFetch('/bugs', { method: 'POST', body: JSON.stringify(body) });
       spinner.succeed(
-        `Bug logged ${chalk.dim(shortId(bug._id))} — ${colorSev(bug.severity)} ${chalk.bold(bug.title)}`,
+        `Bug logged ${chalk.dim(shortId(bug._id))} - ${colorSev(bug.severity)} ${chalk.bold(bug.title)}`,
       );
     } catch (err) {
       spinner.fail();
@@ -126,7 +126,7 @@ program
       }
       const bug = await apiFetch(`/bugs/${id}`, { method: 'PATCH', body: JSON.stringify(body) });
       spinner.succeed(
-        `Updated ${chalk.dim(shortId(bug._id))} — status: ${colorStatus(bug.status)}, sev: ${colorSev(bug.severity)}`,
+        `Updated ${chalk.dim(shortId(bug._id))} - status: ${colorStatus(bug.status)}, sev: ${colorSev(bug.severity)}`,
       );
     } catch (err) {
       spinner.fail();
@@ -192,7 +192,7 @@ program
       };
       const bug = await apiFetch('/bugs', { method: 'POST', body: JSON.stringify(body) });
       spinner.succeed(
-        `Piped bug logged ${chalk.dim(shortId(bug._id))} — ${colorSev(bug.severity)} ${chalk.bold(bug.title)}`,
+        `Piped bug logged ${chalk.dim(shortId(bug._id))} - ${colorSev(bug.severity)} ${chalk.bold(bug.title)}`,
       );
     } catch (err) {
       spinner.fail();
@@ -200,7 +200,7 @@ program
     }
   });
 
-// bug login — device flow
+// bug login - device flow
 program
   .command('login')
   .description('Authenticate via browser')