Skip to content

Chore: Update readme with command examples #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjdammann merged 1 commit into from
Feb 12, 2026
Merged

Chore: Update readme with command examples #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,44 @@ detail auth status

## Usage

The CLI provides commands for managing bugs and repositories. Use `--help` with any command to see detailed usage information:
The CLI provides commands for managing bugs and repositories. Use `--help` with any command to see detailed usage information.

### Bug Management

```bash
# List bugs for a repository
detail bugs list owner/repo --status pending

# Show details for a specific bug
detail bugs show bug_abc123

# Review a bug (mark as resolved)
detail bugs review bug_abc123 --state resolved

# Dismiss a bug with a note
detail bugs review bug_abc123 --state dismissed --dismissal-reason not-a-bug --notes "Example note"
```

### Repository Management

```bash
detail --help
detail bugs --help
detail bugs list --help
# List all repositories you have access to
detail repos list
```

### Output Formats

All list commands support multiple output formats:

```bash
# Table format (default)
detail bugs list owner/repo --format table

# JSON format
detail bugs list owner/repo --format json

# CSV format
detail bugs list owner/repo --format csv
```

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

You can run `detail-update` to manually update the CLI to the latest version.
You can run `detail-cli-update` to manually update the CLI to the latest version.

### Environment Variables

Expand Down