Skip to content

Commit 991d3a0

Browse files
committed
Document -Q
1 parent 1dbdd3f commit 991d3a0

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,24 @@ myproj $ code .
153153

154154
</details>
155155

156+
## What Can `pkgx` Run?
157+
158+
We have a web based package listing at
159+
[pkgx.dev/pkgs](https://pkgx.dev/pkgs/).
160+
161+
From the CLI you can use query mode:
162+
163+
```sh
164+
$ pkgx -Q git
165+
# ^^ can you run git? (outputs the fully qualified project name)
166+
167+
$ pkgx -Q
168+
# ^^ list everything that could be run
169+
170+
$ pkgx -Q | grep git-
171+
# ^^ what git extensions does pkgx provide?
172+
```
173+
156174
&nbsp;
157175

158176
# The `pkgx` Ecosystem

docs/pkgx.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ $ pkgx openai --version
88
openai 1.59.6
99
```
1010

11+
## Search
12+
13+
Generally you don’t need to search since you already know what you want to
14+
run, so just type it! Sometimes though you want to browse.
15+
16+
We have a web based package listing at
17+
[pkgx.dev/pkgs/](https://pkgx.dev/pkgs/). This is the most thorough resource
18+
at this time.
19+
20+
And from the CLI you can use query mode:
21+
22+
```sh
23+
$ pkgx -Q git
24+
# ^^ can we run git?
25+
26+
$ pkgx -Q | grep git-
27+
# ^^ search for all git extensions
28+
29+
$ $ pkgx -Q
30+
# ^^ list every program pkgx can run
31+
```
32+
1133
## Run Any Version
1234

1335
```sh

0 commit comments

Comments
 (0)