Skip to content

Commit 8d52d48

Browse files
committed
Improve command quality
1 parent ac6eaea commit 8d52d48

149 files changed

Lines changed: 4607 additions & 1588 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

assets/commands/ab.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,34 @@ The tool reports statistics including requests per second, time per request, tra
6060
> Add a Cookie header (name=value)
6161
6262
**-s** _timeout_
63-
> Maximum seconds to wait for each response (default 30)
63+
> Maximum seconds to wait before socket times out (default 30)
6464
6565
**-v** _verbosity_
66-
> Verbosity level (1-4)
66+
> Verbosity level (2=warnings, 3=response codes, 4+=headers)
67+
68+
**-u** _file_
69+
> File containing data to PUT (also set -T)
70+
71+
**-X** _proxy[:port]_
72+
> Use a proxy server for the requests
73+
74+
**-e** _csv-file_
75+
> Write a CSV file with response time percentiles (1%-100%)
76+
77+
**-g** _gnuplot-file_
78+
> Write measured values as a gnuplot/TSV file
79+
80+
**-i**
81+
> Use HEAD requests instead of GET
82+
83+
**-l**
84+
> Accept variable document length (for dynamic pages)
85+
86+
**-r**
87+
> Don't exit on socket receive errors
88+
89+
**-q**
90+
> Suppress progress messages on stderr (for >150 requests)
6791
6892
# CAVEATS
6993

@@ -75,4 +99,4 @@ The tool reports statistics including requests per second, time per request, tra
7599

76100
# SEE ALSO
77101

78-
[curl](/man/curl)(1), [wrk](/man/wrk)(1), [siege](/man/siege)(1), [httperf](/man/httperf)(1)
102+
[curl](/man/curl)(1), [wrk](/man/wrk)(1), [siege](/man/siege)(1)

assets/commands/ajson.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,49 @@ Query JSON data using JSONPath expressions
44

55
# TLDR
66

7-
**Query** JSON using JSONPath
7+
**Query** a JSON file using JSONPath
88

99
```ajson '$.store.book[*].author' [file.json]```
1010

1111
Query from **stdin**
1212

1313
```echo '{"name":"John"}' | ajson '$.name'```
1414

15-
Get array **element**
16-
17-
```ajson '$[0]' [array.json]```
18-
1915
Filter with **condition**
2016

2117
```ajson '$.store.book[?(@.price < 10)]' [file.json]```
2218

19+
Read **multiline** JSON (one JSON object per line)
20+
21+
```ajson -m '$.name' [file.jsonl]```
22+
23+
**Evaluate** an expression over JSON data
24+
25+
```ajson 'avg($..price)' [file.json]```
26+
2327
# SYNOPSIS
2428

25-
**ajson** [_options_] _jsonpath_ [_file_]
29+
**ajson** [**-mq**] _jsonpath_ [_file_]
2630

2731
# DESCRIPTION
2832

29-
**ajson** is a command-line tool for querying JSON data using JSONPath expressions. It provides a powerful way to extract specific data from JSON structures, supporting filters, wildcards, and recursive descent.
33+
**ajson** is a command-line tool written in Go for querying and evaluating JSON data using JSONPath expressions. It reads JSON from a file or stdin and supports filters, wildcards, recursive descent, and evaluation functions such as **avg**, **sum**, **length**, **first**, **last**, and math functions.
3034

31-
JSONPath syntax is similar to XPath for XML, with **$** representing the root object, **.** for property access, and **[]** for array indexing or filtering.
35+
JSONPath syntax is similar to XPath for XML, with **$** representing the root object, **.** for property access, **[]** for array indexing or filtering, and **..** for recursive descent.
3236

3337
# PARAMETERS
3438

3539
**jsonpath**
36-
> JSONPath expression to evaluate
40+
> JSONPath expression or evaluation string to evaluate.
3741
3842
**file**
39-
> JSON file to query (reads stdin if omitted)
43+
> Path to JSON file (reads stdin if omitted).
4044
41-
**-c**, **--compact**
42-
> Compact output (no pretty printing)
45+
**-m**, **--multiline**
46+
> Read input as multiline JSON, where each line is a separate valid JSON object.
4347
44-
**-r**, **--raw**
45-
> Output raw strings without quotes
48+
**-q**, **--quiet**
49+
> Do not print errors to stderr.
4650
4751
# CAVEATS
4852

@@ -54,4 +58,4 @@ JSONPath implementations may vary in supported features. Complex nested queries
5458

5559
# SEE ALSO
5660

57-
[jq](/man/jq)(1), [jsonpath](/man/jsonpath)(1), [json](/man/json)(1)
61+
[jq](/man/jq)(1), [yq](/man/yq)(1), [fx](/man/fx)(1), [gron](/man/gron)(1)

assets/commands/apt-cache.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Query the APT package cache
88

99
```apt-cache search [query]```
1010

11+
**Search** only in package names
12+
13+
```apt-cache search --names-only [query]```
14+
1115
Show **information** about a package
1216

1317
```apt-cache show [package]```
@@ -24,6 +28,10 @@ Show packages that **depend on** a particular package
2428

2529
```apt-cache rdepends [package]```
2630

31+
Show **available versions** in a table format
32+
33+
```apt-cache madison [package]```
34+
2735
# SYNOPSIS
2836

2937
**apt-cache** [_options_] _command_ [_arguments_]
@@ -36,39 +44,57 @@ Common operations include searching for packages by name or description, inspect
3644

3745
# PARAMETERS
3846

39-
**search query**
40-
> Search for packages matching the query in names and descriptions
47+
**search** _regex_
48+
> Search for packages matching the POSIX regex in names and descriptions
49+
50+
**show** _package_
51+
> Show detailed package record for a package
4152
42-
**show package**
43-
> Show detailed information about a package
53+
**showpkg** _package_
54+
> Show general information including versions and dependencies
4455
45-
**showpkg package**
46-
> Show general information about a package
56+
**showsrc** _package_
57+
> Show all source package records for a package
4758
48-
**policy [package]**
49-
> Show policy settings and installation status
59+
**policy** [_package_]
60+
> Show policy settings, installation status, and repository priorities
5061
51-
**depends package**
62+
**depends** _package_
5263
> Show dependencies for a package
5364
54-
**rdepends package**
65+
**rdepends** _package_
5566
> Show reverse dependencies (packages that depend on this one)
5667
57-
**pkgnames [prefix]**
58-
> List all package names in the cache
68+
**madison** _package_
69+
> Show available versions in a tabular format
70+
71+
**pkgnames** [_prefix_]
72+
> List all package names in the cache, optionally filtered by prefix
5973
6074
**stats**
6175
> Show cache statistics
6276
6377
**dump**
6478
> Show a short listing of every package in the cache
6579
66-
**--full**
67-
> Print full records when searching
80+
**unmet**
81+
> Show a summary of all unmet dependencies in the cache
82+
83+
**-f, --full**
84+
> Print full package records when searching
6885
6986
**-n, --names-only**
7087
> Only search package names, not descriptions
7188
89+
**-i, --important**
90+
> Print only Depends and Pre-Depends relations (for use with depends and unmet)
91+
92+
**--installed**
93+
> Limit output to currently installed packages
94+
95+
**--recurse**
96+
> Make depends and rdepends recursive
97+
7298
# CONFIGURATION
7399

74100
**/etc/apt/sources.list**
@@ -90,4 +116,4 @@ Part of the **APT** (Advanced Package Tool) suite developed for Debian-based sys
90116

91117
# SEE ALSO
92118

93-
[apt](/man/apt)(8), [apt-get](/man/apt-get)(8), [dpkg](/man/dpkg)(1)
119+
[apt](/man/apt)(8), [apt-get](/man/apt-get)(8), [aptitude](/man/aptitude)(8), [dpkg](/man/dpkg)(1)

assets/commands/asp.md

Lines changed: 61 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,21 @@ Retrieve Arch Linux package build files
1616

1717
```asp export [package]```
1818

19-
**List available packages in a repository**
19+
**List repositories** containing a package
2020

21-
```asp list-repos```
21+
```asp list-repos [package]```
2222

23-
**Show package information**
23+
**Show** PKGBUILD content for a package
2424

2525
```asp show [package]```
2626

27-
**Discard local changes and reset to upstream**
27+
**View revision history** for a package
2828

29-
```asp update -f [package]```
29+
```asp log [package]```
30+
31+
**List all locally tracked** packages
32+
33+
```asp list-local```
3034

3135
# SYNOPSIS
3236

@@ -35,42 +39,78 @@ Retrieve Arch Linux package build files
3539
# PARAMETERS
3640

3741
**checkout** _package_
38-
> Clone a package's build files into a local directory.
39-
40-
**update** [_packages_]
41-
> Update checked-out packages to latest version.
42+
> Create a git repository with full source and history for the given package.
4243
4344
**export** _package_
44-
> Copy PKGBUILD and related files to current directory.
45+
> Dump build source files into a directory named after the package in the current directory.
4546
46-
**list-repos**
47-
> List all available repositories.
47+
**update** [_packages_]
48+
> Track new packages or refresh existing ones from remote.
4849
49-
**show** _package_
50-
> Display package information.
50+
**show** _package_ [_file_]
51+
> Display PKGBUILD content, or a specific file if given.
52+
53+
**log** _package_
54+
> Show revision history for a package.
5155
5256
**difflog** _package_
53-
> Show commit history for a package.
57+
> Show revision history with file diffs.
58+
59+
**shortlog** _package_
60+
> Show condensed revision history.
61+
62+
**list-repos** _package_
63+
> List repositories containing the given package.
64+
65+
**list-arches** _package_
66+
> List architectures available for the given package.
67+
68+
**list-all**
69+
> List all available packages.
70+
71+
**list-local**
72+
> List all locally tracked packages.
73+
74+
**ls-files** _package_
75+
> List source files for the given package.
76+
77+
**untrack** _package_
78+
> Remove remote tracking branch from local repository.
79+
80+
**disk-usage**
81+
> Report approximate disk usage for locally tracked packages.
82+
83+
**gc**
84+
> Perform housekeeping to optimize and compact the local repo.
85+
86+
**set-git-protocol** _protocol_
87+
> Set communication protocol (git, http, or https).
88+
89+
**-a** _arch_
90+
> Use a non-default architecture.
91+
92+
**-h**
93+
> Display help text.
5494
55-
**-f**, **--force**
56-
> Force update, discarding local changes.
95+
**-V**
96+
> Show version information.
5797
5898
# DESCRIPTION
5999

60-
**asp** (Arch Source Package) is a tool for retrieving PKGBUILDs and related build files from the official Arch Linux package repositories. It provides access to the source recipes used to build packages in the core, extra, and multilib repositories.
100+
**asp** (Arch Build Source Management Tool) manages version-controlled sources for the build scripts used to create Arch Linux packages. It provides a thin wrapper over the svntogit repositories and serves as a replacement for the older **abs** tool.
61101

62-
Unlike downloading PKGBUILDs manually, asp uses a Git-based backend that enables tracking changes, viewing commit history, and updating packages efficiently. Each package is a separate Git branch, making it easy to see modifications between versions.
102+
Unlike downloading PKGBUILDs manually, asp uses a Git-based backend with sparse checkouts, enabling tracking changes, viewing commit history, and updating individual packages efficiently.
63103

64104
Common uses include: examining how official packages are built, modifying packages with custom options, backporting patches, and learning PKGBUILD best practices from official examples.
65105

66106
# CAVEATS
67107

68-
asp only provides build files from official Arch repositories, not the AUR. The checked-out files require **makepkg** to actually build packages. Local modifications are overwritten by **asp update -f**. Requires Git to be installed for the underlying VCS operations.
108+
asp only provides build files from official Arch repositories, not the AUR. The checked-out files require **makepkg** to actually build packages. Requires Git to be installed for the underlying VCS operations. Package metadata is stored in **$ASPROOT** (defaults to **$XDG_CACHE_HOME/asp** or **~/.cache/asp**).
69109

70110
# HISTORY
71111

72112
The **asp** tool was created to replace the older **abs** (Arch Build System) tool, which downloaded a complete copy of all PKGBUILDs. Introduced around **2015**, asp uses Git to provide more efficient, incremental access to individual packages. It became the recommended method for obtaining official PKGBUILDs as the Arch package repositories moved to Git-based workflows.
73113

74114
# SEE ALSO
75115

76-
[makepkg](/man/makepkg)(8), [pacman](/man/pacman)(8), [yay](/man/yay)(8), [pkgctl](/man/pkgctl)(1)
116+
[makepkg](/man/makepkg)(8), [pacman](/man/pacman)(8), [yay](/man/yay)(1), [paru](/man/paru)(1), [pkgctl](/man/pkgctl)(1), [git](/man/git)(1)

0 commit comments

Comments
 (0)