Skip to content

docs: correct the README key table for 0.19.0 #46

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
jwarykowski merged 1 commit into from
Jul 29, 2026
Merged

docs: correct the README key table for 0.19.0 #46

Show file tree
Hide file tree
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
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ herdr plugin install jwarykowski/shepherd
| key | action |
|-----|--------|
| `j` / `↓`, `k` / `↑` | move |
| `space` / `enter` | toggle done (on a parent, cascades to its subtasks; the last subtask done completes the parent) |
| `space` | toggle done (on a parent, cascades to its subtasks; the last subtask done completes the parent) |
| `tab` | cycle status (open → in-progress → done → open); see `statuses` config |
| `h` / `m` / `l` | set priority high / medium / low |
| `g` | set category |
Expand Down Expand Up @@ -101,9 +101,9 @@ herdr plugin install jwarykowski/shepherd
The detail view is also an editor: the same field keys work there — `u` text,
`h`/`m`/`l` priority, `g` category, `T` tags, `t` due, `s` defer, `L` link, `tab`
status — and saving returns you to the detail view rather than the list. Plus
`n` edit note · `space` toggle · `o` open link · `esc`/`q` back. Its footer is
the same labelled key grid as the board's, narrowed to the keys that act on the
one item (`fields` · `dates` · `item` · `go`).
`n` edit note · `space` toggle · `o` open link · `esc` back · `q` save + quit. Its
footer is the same labelled key grid as the board's, narrowed to the keys that
act on the one item (`fields` · `dates` · `item` · `go`).

**Rows carry two flush-right values**: the subtask progress (`1/2`) when the item
has subtasks, else the due/defer label — then, pinned far right, whichever
Expand Down Expand Up @@ -212,6 +212,10 @@ board grouping each board is a header; in the others every row carries a
editing stays on the focused board, so the aggregate is never written back.
`/` filters across boards (including by board name).

Only the keys that read or navigate work here — `j`/`k`, `d`, `v`, `/`, `e`, `b`,
`o`, `F`, `?`, `A`/`esc` to leave, `q` to quit. Every editing key is inert and
shown dimmed in the footer, on the board and in the detail view alike.

The command API mirrors it: `shepherd list --all` (see [command api](#command-api)).

## launch filter
Expand Down
4 changes: 2 additions & 2 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ func main() {
}

flag.Usage = func() { fmt.Fprintln(os.Stderr, cli.Usage()) }
filter := flag.String("filter", os.Getenv("SHEPHERD_FILTER"), "start with this filter applied (matches text/note/category/due)")
board := flag.String("board", "", "open this board's board (else $SHEPHERD_BOARD, else the default)")
filter := flag.String("filter", os.Getenv("SHEPHERD_FILTER"), "start with this filter applied (matches text/note/category/tags/due/defer/link)")
board := flag.String("board", "", "open this named board (else $SHEPHERD_BOARD, else the default)")
all := flag.Bool("all", false, "open the read-only global view across all boards")
ver := flag.Bool("version", false, "print the version and exit")
flag.Parse()
Expand Down
Loading