diff --git a/tldr/linux/dpkg-deb b/tldr/linux/dpkg-deb index b13cbcf5..cab35f13 100644 --- a/tldr/linux/dpkg-deb +++ b/tldr/linux/dpkg-deb @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Display information about a package: -`dpkg-deb --info {{path/to/file.deb}}` +`dpkg-deb {{[-I|--info]}} {{path/to/file.deb}}` - Display the package's name and version on one line: -`dpkg-deb --show {{path/to/file.deb}}` +`dpkg-deb {{[-W|--show]}} {{path/to/file.deb}}` - List the package's contents: -`dpkg-deb --contents {{path/to/file.deb}}` +`dpkg-deb {{[-c|--contents]}} {{path/to/file.deb}}` - Extract package's contents into a directory: -`dpkg-deb --extract {{path/to/file.deb}} {{path/to/directory}}` +`dpkg-deb {{[-x|--extract]}} {{path/to/file.deb}} {{path/to/directory}}` - Create a package from a specified directory: -`dpkg-deb --build {{path/to/directory}}` +`dpkg-deb {{[-b|--build]}} {{path/to/directory}}` diff --git a/tldr/linux/dpkg-query b/tldr/linux/dpkg-query index b0e67c2d..25fbc292 100644 --- a/tldr/linux/dpkg-query +++ b/tldr/linux/dpkg-query @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - List all installed packages: -`dpkg-query --list` +`dpkg-query {{[-l|--list]}}` - List installed packages matching a pattern: -`dpkg-query --list '{{libc6*}}'` +`dpkg-query {{[-l|--list]}} '{{libc6*}}'` - List all files installed by a package: -`dpkg-query --listfiles {{libc6}}` +`dpkg-query {{[-L|--listfiles]}} {{libc6}}` - Show information about a package: -`dpkg-query --status {{libc6}}` +`dpkg-query {{[-s|--status]}} {{libc6}}` - Search for packages that own files matching a pattern: -`dpkg-query --search {{/etc/ld.so.conf.d}}` +`dpkg-query {{[-S|--search]}} {{/etc/ld.so.conf.d}}` diff --git a/tldr/linux/lshw b/tldr/linux/lshw index f7b85bc2..b61edc65 100644 --- a/tldr/linux/lshw +++ b/tldr/linux/lshw @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - List all disks and storage controllers in tabular format: -`sudo lshw -class disk -class storage -short` +`sudo lshw {{[-c|-class]}} disk -class storage -short` -- Save all network interfaces to an HTML file: +- Save all network interfaces to an HTML/XML/JSON file: -`sudo lshw -class network -html > {{interfaces.html}}` +`sudo lshw {{[-c|-class]}} network -{{html|xml|json}} > interfaces{{.html|.xml|.json}}` diff --git a/tldr/linux/rofi b/tldr/linux/rofi index e3ba1a18..fc7e0f12 100644 --- a/tldr/linux/rofi +++ b/tldr/linux/rofi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rofi > An application launcher and window switcher. -> More information: . +> More information: . - Show the list of apps: diff --git a/tldr/linux/wofi b/tldr/linux/wofi index a6cda999..4f5bfbef 100644 --- a/tldr/linux/wofi +++ b/tldr/linux/wofi @@ -6,18 +6,18 @@ source: https://github.com/tldr-pages/tldr.git # wofi > An application launcher for wlroots-based Wayland compositors, similar to `rofi` and `dmenu`. -> More information: . +> More information: . - Show the list of apps: -`wofi --show drun` +`wofi {{[-S|--show]}} drun` - Show the list of all commands: -`wofi --show run` +`wofi {{[-S|--show]}} run` - Pipe a list of items to `stdin` and print the selected item to `stdout`: `printf "{{Choice1 Choice2 -Choice3}}" | wofi --dmenu` +Choice3}}" | wofi {{[-d|--dmenu]}}` diff --git a/tldr/pulumi-about b/tldr/pulumi-about index b554a29a..e34b799e 100644 --- a/tldr/pulumi-about +++ b/tldr/pulumi-about @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Print information about the Pulumi environment in JSON format: -`pulumi about --json` +`pulumi about {{[-j|--json]}}` - Print information about the Pulumi environment of a specific stack: -`pulumi about --stack {{stack_name}}` +`pulumi about {{[-s|--stack]}} {{stack_name}}` - Display help: -`pulumi about --help` +`pulumi about {{[-h|--help]}}` diff --git a/tldr/pulumi-cancel b/tldr/pulumi-cancel index 72206778..0690543e 100644 --- a/tldr/pulumi-cancel +++ b/tldr/pulumi-cancel @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Skip confirmation prompts, and proceed with cancellation anyway: -`pulumi cancel --yes` +`pulumi cancel {{[-y|--yes]}}` - Display help: -`pulumi cancel --help` +`pulumi cancel {{[-h|--help]}}` diff --git a/tldr/pulumi-config b/tldr/pulumi-config index 8479cb3b..076cc210 100644 --- a/tldr/pulumi-config +++ b/tldr/pulumi-config @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - View current configuration in JSON format: -`pulumi config --json` +`pulumi config {{[-j|--json]}}` - View configuration for a specified stack: -`pulumi config --stack {{stack_name}}` +`pulumi config {{[-s|--stack]}} {{stack_name}}` - Get the value of a configuration key: diff --git a/tldr/pulumi-destroy b/tldr/pulumi-destroy index a65b7d44..cd89c0ae 100644 --- a/tldr/pulumi-destroy +++ b/tldr/pulumi-destroy @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Destroy all resources in a specific stack: -`pulumi destroy --stack {{stack}}` +`pulumi destroy {{[-s|--stack]}} {{stack}}` - Automatically approve and destroy resources after previewing: -`pulumi destroy --yes` +`pulumi destroy {{[-y|--yes]}}` - Exclude protected resources from being destroyed: diff --git a/tldr/pulumi-env b/tldr/pulumi-env index d82ddd9d..fd59fcd8 100644 --- a/tldr/pulumi-env +++ b/tldr/pulumi-env @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`pulumi env --help` +`pulumi env {{[-h|--help]}}` diff --git a/tldr/pulumi-new b/tldr/pulumi-new index 5e51c5cc..ebeec4d8 100644 --- a/tldr/pulumi-new +++ b/tldr/pulumi-new @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Use the specified secrets provider with the backend: -`pulumi new --secrets-provider={{passphrase}}` +`pulumi new --secrets-provider {{passphrase}}` diff --git a/tldr/pulumi-preview b/tldr/pulumi-preview index 69602d87..0f16b0b8 100644 --- a/tldr/pulumi-preview +++ b/tldr/pulumi-preview @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Show a preview of updates to a stack's resources in JSON format: -`pulumi preview --json` +`pulumi preview {{[-j|--json]}}` - Preview updates as a rich diff showing overall changes: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`pulumi preview --help` +`pulumi preview {{[-h|--help]}}` diff --git a/tldr/pulumi-refresh b/tldr/pulumi-refresh index 9b934603..d663197f 100644 --- a/tldr/pulumi-refresh +++ b/tldr/pulumi-refresh @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - The name of the stack to operate on (defaults to the current stack): -`pulumi refresh --stack {{stack_name}}` +`pulumi refresh {{[-s|--stack]}} {{stack_name}}` - Display help: -`pulumi refresh --help` +`pulumi refresh {{[-h|--help]}}` diff --git a/tldr/pulumi-stack b/tldr/pulumi-stack index 01681ab2..dec65f8f 100644 --- a/tldr/pulumi-stack +++ b/tldr/pulumi-stack @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Show the stack state along with resource URNs: -`pulumi stack --show-urns` +`pulumi stack {{[-u|--show-urns]}}` - List stacks in the current project: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - List stacks across all projects: -`pulumi stack ls --all` +`pulumi stack ls {{[-a|--all]}}` - Select an active stack: diff --git a/tldr/pulumi-state b/tldr/pulumi-state index 0d305eca..df000d34 100644 --- a/tldr/pulumi-state +++ b/tldr/pulumi-state @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`pulumi state --help` +`pulumi state {{[-h|--help]}}` diff --git a/tldr/pulumi-up b/tldr/pulumi-up index a43a4d37..558b24f2 100644 --- a/tldr/pulumi-up +++ b/tldr/pulumi-up @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Automatically approve and perform the update after previewing it: -`pulumi up --yes` +`pulumi up {{[-y|--yes]}}` - Preview and deploy changes in a specific stack: -`pulumi up --stack {{stack}}` +`pulumi up {{[-s|--stack]}} {{stack}}` - Don't display stack outputs: diff --git a/tldr/reuse b/tldr/reuse new file mode 100644 index 00000000..2bf3dd7d --- /dev/null +++ b/tldr/reuse @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# reuse + +> Tool for compliance with the REUSE recommendations. +> More information: . + +- Lint for REUSE compliance for the current project (version control aware): + +`reuse lint` + +- Lint for REUSE compliance from the specified directory: + +`reuse --root {{path/to/directory}} lint` + +- Download a license by its SPDX identifier and place it in the LICENSES directory: + +`reuse download {{spdx-identifier}}` + +- Download all missing licenses detected in the project: + +`reuse download --all` diff --git a/tldr/sqlx b/tldr/sqlx new file mode 100644 index 00000000..82869bf4 --- /dev/null +++ b/tldr/sqlx @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sqlx + +> Command-line utility for SQLx, the Rust SQL toolkit. +> More information: . + +- Create the database specified in the DATABASE_URL environment variable: + +`sqlx database create` + +- Drop the specified database: + +`sqlx database drop {{[-D|--database-url]}} {{database_url}}` + +- Create a new pair of up and down migration files with the given description in the "migrations" directory: + +`sqlx migrate add -r {{migration_description}}` + +- Run all pending migrations for the specified database: + +`sqlx migrate run {{[-D|--database-url]}} {{database_url}}` + +- Revert the latest migration for the specified database: + +`sqlx migrate revert {{[-D|--database-url]}} {{database_url}}` diff --git a/tldr/watch b/tldr/watch index 8bbe5740..01c6c80a 100644 --- a/tldr/watch +++ b/tldr/watch @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Re-run a command every 60 seconds: -`watch {{[-n|--interval]}} {{60}} {{command}}` +`watch {{[-n|--interval]}} 60 {{command}}` - Monitor disk space, highlighting differences as they appear: