bugit-cli 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -0
- package/package.json +11 -4
package/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# bugit-cli
|
|
2
|
+
|
|
3
|
+
Log bugs from your terminal without breaking your flow.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g bugit-cli
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Authentication
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
bug login # opens a browser tab to authenticate
|
|
13
|
+
bug whoami # show your email and API endpoint
|
|
14
|
+
bug logout # clear stored credentials
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Commands
|
|
18
|
+
|
|
19
|
+
### Log a bug
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bug log "Login crashes on Safari 17"
|
|
23
|
+
bug log "Checkout 500 on mobile" -s critical -p storefront -e prod
|
|
24
|
+
bug log "Slow query on reports page" -s medium -p api -t postgres,performance
|
|
25
|
+
bug log "Build failing" -s high --desc "Error: cannot find module 'react'"
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**Options**
|
|
29
|
+
|
|
30
|
+
| Flag | Description | Default |
|
|
31
|
+
|------|-------------|---------|
|
|
32
|
+
| `-s, --sev` | `low` \| `medium` \| `high` \| `critical` | `medium` |
|
|
33
|
+
| `-p, --project` | Project name | |
|
|
34
|
+
| `-e, --env` | `local` \| `staging` \| `prod` | |
|
|
35
|
+
| `-d, --desc` | Description or steps to reproduce | |
|
|
36
|
+
| `-n, --notes` | Root cause or fix notes | |
|
|
37
|
+
| `-t, --tags` | Comma-separated tags | |
|
|
38
|
+
|
|
39
|
+
### Pipe from stdin
|
|
40
|
+
|
|
41
|
+
Pipe build errors, stack traces, or any output directly into a bug.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm run build 2>&1 | bug pipe "Build failed" -s high -p myapp
|
|
45
|
+
cat error.log | bug pipe "Server crash" -s critical -e prod
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### List bugs
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
bug list # all bugs, last 20
|
|
52
|
+
bug list --status open
|
|
53
|
+
bug list --sev critical
|
|
54
|
+
bug list -p myapp --limit 50
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### View a bug
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
bug view <id> # accepts full ID or short 6-char ID
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Update a bug
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
bug update <id> --status in-progress
|
|
67
|
+
bug update <id> --sev critical --notes "narrowed to auth middleware"
|
|
68
|
+
bug update <id> --tags nestjs,redis
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Shortcuts
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
bug resolve <id> # set status to resolved
|
|
75
|
+
bug wontfix <id> # set status to wontfix
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Web dashboard
|
|
79
|
+
|
|
80
|
+
Review, filter, and comment on bugs at [https://bugit-dev.vercel.app](https://bugit-dev.vercel.app).
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bugit-cli",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "BugIt CLI
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"description": "BugIt CLI - capture bugs from your terminal",
|
|
5
5
|
"author": "Golden Azubuike <goldenazubuike@gmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"homepage": "https://bugit-dev.vercel.app",
|
|
@@ -9,12 +9,19 @@
|
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "https://github.com/goldenazubuike/bugit"
|
|
11
11
|
},
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"bug",
|
|
14
|
+
"tracker",
|
|
15
|
+
"cli",
|
|
16
|
+
"developer-tools",
|
|
17
|
+
"debugging"
|
|
18
|
+
],
|
|
13
19
|
"bin": {
|
|
14
20
|
"bug": "./src/index.js"
|
|
15
21
|
},
|
|
16
22
|
"files": [
|
|
17
|
-
"src/"
|
|
23
|
+
"src/",
|
|
24
|
+
"README.md"
|
|
18
25
|
],
|
|
19
26
|
"scripts": {
|
|
20
27
|
"start": "node src/index.js"
|