You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
+++
|
|
title = "Update claude-md snippet to show --json on all commands"
|
|
priority = 4
|
|
status = "done"
|
|
ticket_type = "task"
|
|
dependencies = []
|
|
+++
|
|
## Goal
|
|
|
|
The `nbd claude-md` command emits `src/claude_md_snippet.md` verbatim. The current snippet shows core commands without `--json`, contradicting the guideline at the bottom that says to always pass it.
|
|
|
|
## What to change
|
|
|
|
In `src/claude_md_snippet.md`, update the **Core commands** section so every example includes `--json`:
|
|
|
|
```sh
|
|
# Create a new ticket (use --ftype md for a human-readable body)
|
|
nbd create --title "Add OAuth login" --type feature --priority 7 --ftype md --json
|
|
|
|
# List all open tickets (sorted by priority)
|
|
nbd list --json
|
|
|
|
# Read a specific ticket
|
|
nbd read <id> --json
|
|
|
|
# Update a ticket
|
|
nbd update <id> --status in_progress --json
|
|
nbd update <id> --status done --json
|
|
```
|
|
|
|
Also update the **Workflow** numbered list to use `--json` in every command:
|
|
|
|
```
|
|
1. **Before starting** — create a ticket: `nbd create --title "..." --ftype md --json`
|
|
2. **When starting** — mark it in progress: `nbd update <id> --status in_progress --json`
|
|
3. **When done** — mark it complete: `nbd update <id> --status done --json`
|
|
```
|
|
|
|
The `nbd ready` and `nbd next` sections should also include `--json`.
|
|
|
|
## Files
|
|
|
|
- `src/claude_md_snippet.md` — the only file that needs changing
|
|
|
|
## Validation
|
|
|
|
```sh
|
|
cargo run -- claude-md | grep -c '\-\-json'
|
|
```
|
|
|
|
The count should go up after the change. All existing tests should still pass. |