Skip to content

Commit 1e9981f

Browse files
committed
Improve command quality
1 parent db2c428 commit 1e9981f

50 files changed

Lines changed: 1218 additions & 468 deletions

Some content is hidden

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

assets/commands/arduino-cli.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Official command-line tool for Arduino development
1818

1919
**Compile and upload** in one command
2020

21-
```arduino-cli compile --fqbn [arduino:avr:uno] --port [/dev/ttyACM0] --upload [path/to/sketch]```
21+
```arduino-cli compile --fqbn [arduino:avr:uno] --port [/dev/ttyACM0] -u [path/to/sketch]```
2222

2323
**Create a new sketch**
2424

@@ -36,6 +36,14 @@ Official command-line tool for Arduino development
3636

3737
```arduino-cli lib install "[Servo]"```
3838

39+
**Open serial monitor** on a port
40+
41+
```arduino-cli monitor --port [/dev/ttyACM0]```
42+
43+
**Update platform index** and upgrade all installed platforms
44+
45+
```arduino-cli core update-index && arduino-cli core upgrade```
46+
3947
# SYNOPSIS
4048

4149
**arduino-cli** _command_ [_flags_]
@@ -69,15 +77,27 @@ Official command-line tool for Arduino development
6977
**lib search** _query_
7078
> Search for libraries
7179
80+
**lib list**
81+
> List installed libraries
82+
7283
**monitor**
7384
> Open serial monitor to communicate with the board
7485
86+
**config init**
87+
> Create a default configuration file
88+
89+
**core upgrade**
90+
> Upgrade all installed board platforms to the latest version
91+
7592
**-b**, **--fqbn** _string_
7693
> Fully Qualified Board Name (e.g., arduino:avr:uno)
7794
7895
**-p**, **--port** _string_
7996
> Port address (e.g., /dev/ttyACM0 or COM3)
8097
98+
**-u**, **--upload**
99+
> Upload the binary after compilation (use with compile)
100+
81101
**-e**, **--export-binaries**
82102
> Export compiled binaries to the sketch folder
83103
@@ -87,6 +107,9 @@ Official command-line tool for Arduino development
87107
**-t**, **--verify**
88108
> Verify uploaded binary after upload
89109
110+
**-v**, **--verbose**
111+
> Enable verbose output during compile or upload
112+
90113
**-P**, **--programmer** _name_
91114
> Use a specific programmer for upload
92115

assets/commands/aur.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,21 @@ Collection of scripts for managing AUR packages through a local repository.
2020

2121
```aur sync -u```
2222

23-
**Clean** build files after install
23+
**Clean** build files after syncing
2424

25-
```aur sync -C [package]```
25+
```aur sync -c [package]```
2626

27-
Install a package **without confirmation prompts**
27+
Install a package **without review prompts**
2828

29-
```aur sync --noview -n [package]```
29+
```aur sync --no-view --no-confirm [package]```
30+
31+
**Fetch** package sources from AUR without building
32+
33+
```aur fetch [package]```
34+
35+
Show the **dependency tree** for a package
36+
37+
```aur depends [package]```
3038

3139
# SYNOPSIS
3240

@@ -60,7 +68,7 @@ Unlike AUR helpers that install packages directly, aurutils maintains a proper l
6068
6169
# CAVEATS
6270

63-
Requires a local repository to be configured in **/etc/pacman.conf**. Uses **vifm** by default for PKGBUILD review (can be changed). Building occurs in a clean chroot, requiring **devtools** package. Initial setup is more complex than simple AUR helpers.
71+
Requires a local repository to be configured in **/etc/pacman.conf**. Uses **vifm** by default for PKGBUILD review (configurable via **AUR_PAGER** environment variable). Building occurs in a clean chroot, requiring the **devtools** package. Initial setup is more involved than simple AUR helpers like yay or paru.
6472

6573
# HISTORY
6674

assets/commands/aws-budgets.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Manage cost budgets and spending alerts.
1414

1515
**List all budgets** for an account
1616

17-
```aws budgets describe-budgets --account-id [123456789012]```
17+
```aws budgets describe-budgets --account-id [123456789012] --max-results [100]```
1818

1919
**Get details** of a specific budget
2020

@@ -28,9 +28,9 @@ Manage cost budgets and spending alerts.
2828

2929
```aws budgets delete-budget --account-id [123456789012] --budget-name "[MyBudget]"```
3030

31-
**Create a budget action** (auto-response)
31+
**List budget actions** for a specific budget
3232

33-
```aws budgets create-budget-action --account-id [123456789012] --budget-name "[MyBudget]" --action-type APPLY_IAM_POLICY --action-threshold file://[threshold.json]```
33+
```aws budgets describe-budget-actions-for-budget --account-id [123456789012] --budget-name "[MyBudget]"```
3434

3535
# SYNOPSIS
3636

@@ -77,6 +77,9 @@ Manage cost budgets and spending alerts.
7777
**--new-budget** _json_
7878
> Updated budget specification
7979
80+
**--max-results** _integer_
81+
> Maximum number of results to return (for list operations)
82+
8083
# BUDGET JSON STRUCTURE
8184

8285
```json
@@ -102,12 +105,12 @@ Time units include DAILY, MONTHLY, QUARTERLY, and ANNUALLY. If no start date is
102105

103106
# CAVEATS
104107

105-
Budgets have a processing delay of up to 24 hours for cost data. Budget limits are soft limits that trigger alerts but don't automatically stop spending. Free tier includes 2 budgets; additional budgets incur charges. Account ID must be specified explicitly in CLI commands.
108+
Budgets have a processing delay of up to 24 hours for cost data. Budget limits are soft limits that trigger alerts but don't automatically stop spending unless budget actions are configured. Free tier includes 2 action-enabled budgets per account; additional budgets incur charges. Account ID must be specified explicitly in CLI commands.
106109

107110
# HISTORY
108111

109112
**AWS Budgets** launched in **January 2017** as part of AWS Cost Management tools. It evolved from the earlier Billing Alerts feature. Budget actions for automated responses were added in **2020**, enabling automatic cost control measures beyond just notifications.
110113

111114
# SEE ALSO
112115

113-
[aws](/man/aws)(1), [aws-ce](/man/aws-ce)(1), [aws-organizations](/man/aws-organizations)(1)
116+
[aws](/man/aws)(1), [aws-ce](/man/aws-ce)(1), [aws-sns](/man/aws-sns)(1), [aws-organizations](/man/aws-organizations)(1)

assets/commands/blastdbcmd.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,43 +58,68 @@ The tool is part of the NCBI BLAST+ suite and works with databases created by **
5858
> File containing list of sequence identifiers
5959
6060
**-out** _file_
61-
> Output file (default: stdout)
61+
> Output file (default: stdout).
6262
6363
**-outfmt** _format_
64-
> Custom output format string
64+
> Custom output format string using % tokens.
6565
6666
**-info**
67-
> Display database information
67+
> Display database information (type, number of sequences, total length, date).
6868
6969
**-list** _path_
70-
> List databases in specified path
70+
> List databases in specified path.
7171
7272
**-recursive**
73-
> Search directories recursively (with -list)
73+
> Search directories recursively (with -list).
7474
7575
**-show_blastdb_search_path**
76-
> Display BLAST database search paths
76+
> Display BLAST database search paths.
77+
78+
**-dbtype** _type_
79+
> Database type: nucl (nucleotide) or prot (protein). Needed when both types share a name.
80+
81+
**-target_only**
82+
> Retrieve only target sequences (no redundant group members).
7783
7884
**-tax_info**
79-
> Display taxonomy information (requires taxonomy database)
85+
> Display taxonomy information (requires taxonomy database).
8086
8187
**-range** _start-stop_
82-
> Extract subsequence range
88+
> Extract subsequence range (1-based, inclusive).
89+
90+
**-strand** _strand_
91+
> Strand to retrieve: plus or minus (nucleotide only).
92+
93+
**-line_length** _N_
94+
> Line length for FASTA output (default: 80). Use 0 for single-line sequences.
95+
96+
**-long_seqids**
97+
> Use long sequence identifiers including database and accession.version.
8398
8499
# OUTPUT FORMAT TOKENS
85100

86101
**%a** - Accession
87-
**%t** - Title
88-
**%s** - Sequence
102+
**%g** - GI number
103+
**%o** - OID (ordinal ID)
104+
**%t** - Title (definition line)
105+
**%s** - Sequence data
89106
**%l** - Sequence length
90107
**%T** - Taxonomy ID
91108
**%S** - Scientific name
92109
**%L** - Common name
110+
**%m** - Masking data
111+
**%h** - Hash value
112+
**%e** - Membership integer
113+
114+
# ENVIRONMENT
115+
116+
**BLASTDB**
117+
> Colon-separated list of directories to search for BLAST databases.
93118
94119
# CAVEATS
95120

96-
Requires pre-formatted BLAST databases. Taxonomy information requires the BLAST taxonomy database to be installed. Large extractions may require significant time and disk space.
121+
Requires pre-formatted BLAST databases created by **makeblastdb** or downloaded from NCBI. Taxonomy information requires the BLAST taxonomy database (taxdb.btd/bti) to be installed. Large extractions may require significant time and disk space. The **-range** option uses 1-based inclusive coordinates.
97122

98123
# SEE ALSO
99124

100-
[makeblastdb](/man/makeblastdb)(1), [blastn](/man/blastn)(1), [blastp](/man/blastp)(1), [blastx](/man/blastx)(1)
125+
[makeblastdb](/man/makeblastdb)(1), [blastn](/man/blastn)(1), [blastp](/man/blastp)(1), [blastx](/man/blastx)(1), [tblastn](/man/tblastn)(1)

assets/commands/ccache.md

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ compiler cache for faster recompilation
88

99
```ccache -s```
1010

11+
**Show verbose cache statistics** including hit rates
12+
13+
```ccache -sv```
14+
1115
**Clear the cache**
1216

1317
```ccache -C```
@@ -16,19 +20,23 @@ compiler cache for faster recompilation
1620

1721
```ccache -M [5G]```
1822

19-
**Show configuration**
23+
**Show current configuration**
2024

2125
```ccache -p```
2226

23-
**Zero statistics**
27+
**Zero statistics counters**
2428

2529
```ccache -z```
2630

2731
**Run compiler through ccache**
2832

2933
```ccache [gcc] -c [file.c]```
3034

31-
**Show cache directory**
35+
**Set a configuration value**
36+
37+
```ccache -o [max_size=10G]```
38+
39+
**Show the cache directory path**
3240

3341
```ccache -k cache_dir```
3442

@@ -47,31 +55,43 @@ Supports GCC, Clang, MSVC and similar compilers for C, C++, Objective-C, CUDA, a
4755
# PARAMETERS
4856

4957
**-s**, **--show-stats**
50-
> Show cache statistics
58+
> Show cache statistics summary.
59+
60+
**-sv**
61+
> Show verbose statistics including hit/miss details.
5162
5263
**-z**, **--zero-stats**
53-
> Zero statistics counters
64+
> Zero statistics counters.
5465
5566
**-C**, **--clear**
56-
> Clear entire cache
67+
> Clear entire cache.
5768
5869
**-M**, **--max-size** _size_
59-
> Set maximum cache size (e.g., 5G, 500M)
70+
> Set maximum cache size (e.g., 5G, 500M).
71+
72+
**-F**, **--max-files** _count_
73+
> Set maximum number of files in the cache.
6074
6175
**-p**, **--show-config**
62-
> Show current configuration
76+
> Show current configuration with origins.
6377
6478
**-k**, **--get-config** _key_
65-
> Get configuration value
79+
> Get a single configuration value.
6680
6781
**-o**, **--set-config** _key=value_
68-
> Set configuration value
82+
> Set a configuration value persistently.
83+
84+
**-d**, **--directory** _path_
85+
> Operate on specified cache directory instead of the default.
6986
7087
**--cleanup**
71-
> Clean up cache to stay within size limit
88+
> Clean up cache to stay within size limit.
89+
90+
**--evict-older-than** _age_
91+
> Remove files older than given age (e.g., 30d, 24h).
7292
7393
**-V**, **--version**
74-
> Show version
94+
> Show version.
7595
7696
# SETUP
7797

@@ -95,14 +115,28 @@ export CXX="ccache g++"
95115
**/etc/ccache.conf**
96116
> System-wide configuration defaults.
97117
118+
# ENVIRONMENT
119+
120+
**CCACHE_DIR**
121+
> Path to the cache directory (default: ~/.cache/ccache or ~/.ccache).
122+
123+
**CCACHE_CONFIGPATH**
124+
> Path to the configuration file.
125+
126+
**CCACHE_MAXSIZE**
127+
> Maximum cache size (overrides config file).
128+
129+
**CCACHE_DISABLE** / **CCACHE_NODISABLE**
130+
> Disable or re-enable ccache.
131+
98132
# REMOTE CACHING
99133

100134
Supports remote caching via HTTP, Redis, or NFS for sharing across build machines.
101135

102136
# CAVEATS
103137

104-
Only caches single-file compilations. Multi-file compilation and linking fall back to real compiler. Produces identical output to direct compilation.
138+
Only caches single-file compilations. Multi-file compilation and linking fall back to the real compiler. Produces identical output to direct compilation. Precompiled headers require special configuration.
105139

106140
# SEE ALSO
107141

108-
[gcc](/man/gcc)(1), [clang](/man/clang)(1), [make](/man/make)(1), [distcc](/man/distcc)(1)
142+
[gcc](/man/gcc)(1), [clang](/man/clang)(1), [make](/man/make)(1), [distcc](/man/distcc)(1), [sccache](/man/sccache)(1), [cmake](/man/cmake)(1)

0 commit comments

Comments
 (0)