Skip to content

Commit 7457eb7

Browse files
authored
Chore: Update readme with command examples (#14)
1 parent 6825b6e commit 7457eb7

1 file changed

Lines changed: 37 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,44 @@ detail auth status
3636

3737
## Usage
3838

39-
The CLI provides commands for managing bugs and repositories. Use `--help` with any command to see detailed usage information:
39+
The CLI provides commands for managing bugs and repositories. Use `--help` with any command to see detailed usage information.
40+
41+
### Bug Management
42+
43+
```bash
44+
# List bugs for a repository
45+
detail bugs list owner/repo --status pending
46+
47+
# Show details for a specific bug
48+
detail bugs show bug_abc123
49+
50+
# Review a bug (mark as resolved)
51+
detail bugs review bug_abc123 --state resolved
52+
53+
# Dismiss a bug with a note
54+
detail bugs review bug_abc123 --state dismissed --dismissal-reason not-a-bug --notes "Example note"
55+
```
56+
57+
### Repository Management
4058

4159
```bash
42-
detail --help
43-
detail bugs --help
44-
detail bugs list --help
60+
# List all repositories you have access to
61+
detail repos list
62+
```
63+
64+
### Output Formats
65+
66+
All list commands support multiple output formats:
67+
68+
```bash
69+
# Table format (default)
70+
detail bugs list owner/repo --format table
71+
72+
# JSON format
73+
detail bugs list owner/repo --format json
74+
75+
# CSV format
76+
detail bugs list owner/repo --format csv
4577
```
4678

4779
## Configuration
@@ -61,7 +93,7 @@ To disable automatic updates, add this to your config file:
6193
check_for_updates = false
6294
```
6395

64-
You can run `detail-update` to manually update the CLI to the latest version.
96+
You can run `detail-cli-update` to manually update the CLI to the latest version.
6597

6698
### Environment Variables
6799

0 commit comments

Comments
 (0)