Skip to content

Commit e9e9656

Browse files
committed
Document search command and command aliases in README
1 parent a9e4638 commit e9e9656

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,16 @@ Gemfile.lock:142: rails (7.0.8)
426426

427427
Like `grep` but scoped to manifest files that git-pkgs knows about.
428428

429+
### Search dependencies
430+
431+
```bash
432+
git pkgs search rails # find dependencies matching a pattern
433+
git pkgs search react --ecosystem=npm
434+
git pkgs search "^post" --direct # only direct dependencies, not lockfile
435+
```
436+
437+
Searches the database for dependencies whose names match the given pattern. Shows the matching name, version requirement, ecosystem, and when the dependency was first seen and last changed.
438+
429439
### List commits with dependency changes
430440

431441
```bash
@@ -573,6 +583,17 @@ eval "$(git pkgs completions zsh)"
573583
git pkgs completions install
574584
```
575585

586+
### Aliases
587+
588+
Common commands have shorter alternatives:
589+
590+
- `ls` for `list`
591+
- `rm` for `remove`
592+
- `grep` for `search`
593+
- `find` for `where`
594+
- `audit` for `vulns`
595+
- `praise` for `blame`
596+
576597
## Configuration
577598

578599
git-pkgs respects [standard git configuration](https://git-scm.com/docs/git-config).

0 commit comments

Comments
 (0)