diff --git a/tldr/atq b/tldr/atq index 39b8920e..1d9ec866 100644 --- a/tldr/atq +++ b/tldr/atq @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `atq` -- Show jobs from the 'a' [q]ueue (queues have single-character names): +- Show jobs from the `a` [q]ueue (queues have single-character names): `atq -q {{a}}` diff --git a/tldr/aws-cloudformation b/tldr/aws-cloudformation index 9e81abc6..6988bb30 100644 --- a/tldr/aws-cloudformation +++ b/tldr/aws-cloudformation @@ -32,6 +32,6 @@ source: https://github.com/tldr-pages/tldr.git `aws cloudformation detect-stack-drift --stack-name {{stack-id}} --profile {{profile}}` -- Check the drift status output of a stack using 'StackDriftDetectionId' from the previous command output: +- Check the drift status output of a stack using `StackDriftDetectionId` from the previous command output: `aws cloudformation describe-stack-resource-drifts --stack-name {{stack-drift-detection-id}} --profile {{profile}}` diff --git a/tldr/compgen b/tldr/compgen index 5fb6c32e..1c4387f5 100644 --- a/tldr/compgen +++ b/tldr/compgen @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git `compgen -k` -- See all available commands/aliases starting with 'ls': +- See all available commands/aliases starting with `ls`: `compgen -ac {{ls}}` diff --git a/tldr/crane-pull b/tldr/crane-pull index 89558abe..c2a45e08 100644 --- a/tldr/crane-pull +++ b/tldr/crane-pull @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `crane pull {{image_name}} {{path/to/tarball}}` -- Preserve image reference used to pull as an annotation when used with --format=oci: +- Preserve image reference used to pull as an annotation when used with `--format=oci`: `crane pull {{image_name}} {{path/to/tarball}} --annotate-ref` @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `crane pull {{image_name}} {{path/to/tarball}} {{[-c|--cache_path]}} {{path/to/cache}}` -- Format in which to save images (default 'tarball'): +- Format in which to save images (default `tarball`): `crane pull {{image_name}} {{path/to/tarball}} {{-format}} {{format_name}}` diff --git a/tldr/csvtool b/tldr/csvtool index 2cc758ca..d4943eaa 100644 --- a/tldr/csvtool +++ b/tldr/csvtool @@ -16,14 +16,14 @@ source: https://github.com/tldr-pages/tldr.git `csvtool {{[-c|--column]}} {{2,4}} {{path/to/file.csv}}` -- Extract lines from a CSV file where the second column exactly matches 'Foo': +- Extract lines from a CSV file where the second column exactly matches `Foo`: `csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Foo$}}' {{path/to/file.csv}}` -- Extract lines from a CSV file where the second column starts with 'Bar': +- Extract lines from a CSV file where the second column starts with `Bar`: `csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Bar}}' {{path/to/file.csv}}` -- Find lines in a CSV file where the second column ends with 'Baz' and then extract the third and sixth columns: +- Find lines in a CSV file where the second column ends with `Baz` and then extract the third and sixth columns: `csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{Baz$}}' {{path/to/file.csv}} | csvtool {{[-e|--no-header]}} {{[-c|--column]}} {{3,6}}` diff --git a/tldr/dalfox b/tldr/dalfox index 328f3295..4793bb60 100644 --- a/tldr/dalfox +++ b/tldr/dalfox @@ -6,16 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # dalfox > A powerful open-source XSS scanner focused on automation. -> More information: . +> More information: . - Scan a single URL for XSS vulnerabilities: -`dalfox url {{http://example.com}}` +`dalfox url {{https://example.com}}` - Scan a URL using a header for authentication: -`dalfox url {{http://example.com}} {{[-H|--header]}} '{{X-My-Header: 123}}'` +`dalfox url {{https://example.com}} {{[-H|--header]}} '{{X-My-Header: 123}}'` - Scan a list of URLs from a file: `dalfox file {{path/to/file}}` + +- Start Dalfox as a REST API server: + +`dalfox server --host {{0.0.0.0}} --port {{8080}}` diff --git a/tldr/fisher b/tldr/fisher index 432ee1cc..da89795a 100644 --- a/tldr/fisher +++ b/tldr/fisher @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fisher > Fisher, a fish-shell plugin manager. -> Install plugins by name or from a managed 'fishfile' for bundled installs. +> Install plugins by name or from a managed `fishfile` for bundled installs. > More information: . - Install one or more plugins: @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `fisher {{gist_url}}` -- Edit 'fishfile' manually with your favorite editor and install multiple plugins: +- Edit `fishfile` manually with your favorite editor and install multiple plugins: `{{editor}} ~/.config/fish/fishfile; fisher` diff --git a/tldr/gatsby b/tldr/gatsby index 59e7edb2..c7c20448 100644 --- a/tldr/gatsby +++ b/tldr/gatsby @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `gatsby new {{site_name}}` -- Create a new site with a Gatsby 'starter': +- Create a new site with a Gatsby `starter`: `gatsby new {{site_name}} {{url_of_starter_github_repo}}` diff --git a/tldr/killall b/tldr/killall index 64ea8441..6cac89df 100644 --- a/tldr/killall +++ b/tldr/killall @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `killall {{process_name}}` -- List available signal names (to be used without the 'SIG' prefix): +- List available signal names (to be used without the `SIG` prefix): `killall {{[-l|--list]}}` diff --git a/tldr/kubectl b/tldr/kubectl index b54db060..afb4cd21 100644 --- a/tldr/kubectl +++ b/tldr/kubectl @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `kubectl get {{pod|service|deployment|ingress|...}} {{[-o|--output]}} wide` -- Update specified pod with the label 'unhealthy' and the value 'true': +- Update specified pod with the label `unhealthy` and the value `true`: `kubectl label pods {{name}} unhealthy=true` diff --git a/tldr/linux/ndctl b/tldr/linux/ndctl index f563df0a..edc98274 100644 --- a/tldr/linux/ndctl +++ b/tldr/linux/ndctl @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > Utility for managing Non-Volatile DIMMs. > More information: . -- Create an 'fsdax' mode namespace: +- Create an `fsdax` mode namespace: `ndctl create-namespace --mode={{fsdax}}` -- Change the mode of a namespace to 'raw': +- Change the mode of a namespace to `raw`: `ndctl create-namespace --reconfigure={{namespaceX.Y}} --mode={{raw}}` @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `ndctl list -vvv --namespace={{namespaceX.Y}}` -- Run a monitor to watch for SMART health events for NVDIMMs on the 'ACPI.NFIT' bus: +- Run a monitor to watch for SMART health events for NVDIMMs on the `ACPI.NFIT` bus: `ndctl monitor --bus={{ACPI.NFIT}}` diff --git a/tldr/linux/palworld b/tldr/linux/palworld new file mode 100644 index 00000000..69faae74 --- /dev/null +++ b/tldr/linux/palworld @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# Palworld + +> Create and start a headless Palworld server. +> More information: . + +- Start the server with default settings: + +`{{path/to/PalServer.sh}}` + +- Start the server with a specific port and set a maximum player count: + +`{{path/to/PalServer.sh}} -port={{8211}} -players={{1..32}}` + +- Start a public lobby server: + +`{{path/to/PalServer.sh}} -publiclobby` + +- Start the server with performance optimizations for multi-threaded CPUs: + +`{{path/to/PalServer.sh}} -useperfthreads -NoAsyncLoadingThread -UseMultithreadForDS` + +- Start the server with a specific public IP and port for community servers: + +`{{path/to/PalServer.sh}} -publicip={{ip_address}} -publicport={{port}}` diff --git a/tldr/linux/paru b/tldr/linux/paru index 4b930928..035f8e9b 100644 --- a/tldr/linux/paru +++ b/tldr/linux/paru @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # paru > An AUR helper and pacman wrapper. +> See also: `pacman`, `yay`. > More information: . - Interactively search for and install a package: @@ -20,6 +21,10 @@ source: https://github.com/tldr-pages/tldr.git `paru -Sua` +- Remove an installed package, it's configuration files, and dependencies: + +`paru -Rns {{package}}` + - Get information about a package: `paru -Si {{package}}` diff --git a/tldr/linux/rdesktop b/tldr/linux/rdesktop index 04063b94..13e10de0 100644 --- a/tldr/linux/rdesktop +++ b/tldr/linux/rdesktop @@ -21,9 +21,9 @@ source: https://github.com/tldr-pages/tldr.git `rdesktop -u {{username}} -p {{password}} -f {{host:port}}` -- Use the customed resolution (use the letter 'x' between the number): +- Use a custom resolution (use the letter `x` between the numbers): -`rdesktop -u {{username}} -p {{password}} -g 1366x768 {{host:port}}` +`rdesktop -u {{username}} -p {{password}} -g {{1366}}x{{768}} {{host:port}}` - Connect to a remote computer using domain user: diff --git a/tldr/linux/rename.util b/tldr/linux/rename.util index 3e980ea5..7100eb06 100644 --- a/tldr/linux/rename.util +++ b/tldr/linux/rename.util @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git > Note: This page refers to the command from the `util-linux` package. > More information: . -- Rename files using simple substitutions (substitute 'foo' with 'bar' wherever found): +- Rename files using simple substitutions (substitute `foo` with `bar` wherever found): `rename {{foo}} {{bar}} {{*}}` diff --git a/tldr/linux/virt-viewer b/tldr/linux/virt-viewer index 6147445b..e9499af7 100644 --- a/tldr/linux/virt-viewer +++ b/tldr/linux/virt-viewer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # virt-viewer > Minimal graphical interface for a virtual machine (VM). -> Note: 'domain' refers to the name, UUID or ID for the existing VMs. +> Note: `domain` refers to the name, UUID or ID for the existing VMs. > See also: `virsh`. > More information: . diff --git a/tldr/linux/virt-xml b/tldr/linux/virt-xml index db2ce4c0..badfce8a 100644 --- a/tldr/linux/virt-xml +++ b/tldr/linux/virt-xml @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # virt-xml > Edit libvirt Domain XML files with explicit command-line options. -> Note: 'domain' refers to the name, UUID or ID for the existing VMs. +> Note: `domain` refers to the name, UUID or ID for the existing VMs. > See also: `virsh`. > More information: . diff --git a/tldr/linux/yaourt b/tldr/linux/yaourt index 3cce9fc7..1fc9dadc 100644 --- a/tldr/linux/yaourt +++ b/tldr/linux/yaourt @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `yaourt -Ss {{query}}` -- List installed packages, versions, and repositories (AUR packages will be listed under the repository name 'local'): +- List installed packages, versions, and repositories (AUR packages will be listed under the repository name `local`): `yaourt -Q` diff --git a/tldr/mvn-deploy b/tldr/mvn-deploy new file mode 100644 index 00000000..e2319e68 --- /dev/null +++ b/tldr/mvn-deploy @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mvn deploy + +> Add an artifact to a remote repository. +> More information: . + +- Copy the final artifact into the remote repository configured in the `settings.xml` file: + +`mvn deploy` + +- Copy an artifact, that is not built using Maven to the remote repository: + +`mvn deploy:deploy-file {{[-D|--define]}} url={{URLOfTheRemoteRepository}} {{[-D|--define]}} repositoryId={{ServerIdFromSettingsXML}} {{[-D|--define]}} file={{FileToBeDeployed}}` diff --git a/tldr/mvn-generate-sources b/tldr/mvn-generate-sources new file mode 100644 index 00000000..507524e0 --- /dev/null +++ b/tldr/mvn-generate-sources @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mvn generate-sources + +> Generate source code for a Maven project before the main compilation phase. +> This phase runs after `initialize` and before `process-sources`. +> More information: . + +- Run all lifecycle phases up to `generate-sources`: + +`mvn generate-sources` + +- Run the next phase to generate resources: + +`mvn generate-resources` + +- Clean and regenerate sources: + +`mvn clean generate-sources` diff --git a/tldr/npm-explore b/tldr/npm-explore new file mode 100644 index 00000000..b7230feb --- /dev/null +++ b/tldr/npm-explore @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm explore + +> Browse an installed npm package. +> More information: . + +- Browse an installed package: + +`npm explore {{package_name}}` + +- Browse a package and run a command inside it: + +`npm explore {{package_name}} -- {{command}}` diff --git a/tldr/npm-help-search b/tldr/npm-help-search new file mode 100644 index 00000000..802e5aed --- /dev/null +++ b/tldr/npm-help-search @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm help-search + +> Search npm help documentation using a keyword. +> More information: . + +- Search for commands or topics related to a keyword: + +`npm help-search {{keyword}}` + +- Search with multiple words: + +`npm help-search {{keyword1 keyword2 ...}}` diff --git a/tldr/npm-hook b/tldr/npm-hook new file mode 100644 index 00000000..ead051ed --- /dev/null +++ b/tldr/npm-hook @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm hook + +> Manage `npm` registry hooks for packages. +> Note: This command has been deprecated. +> More information: . + +- List all active hooks: + +`npm hook ls` + +- Add a new hook for a package: + +`npm hook add {{package_name}} {{event}} {{target_url}}` + +- Remove a specific hook by its ID: + +`npm hook rm {{hook_id}}` + +- Update a hook with new information: + +`npm hook update {{hook_id}} {{target_url}}` diff --git a/tldr/npm-rb b/tldr/npm-rb new file mode 100644 index 00000000..9ab35e01 --- /dev/null +++ b/tldr/npm-rb @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm-rb + +> This command is an alias of `npm-rebuild`. + +- View documentation for the original command: + +`tldr npm-rebuild` diff --git a/tldr/npm-rebuild b/tldr/npm-rebuild new file mode 100644 index 00000000..bb80e398 --- /dev/null +++ b/tldr/npm-rebuild @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm rebuild + +> Rebuild native Node.js packages after Node or dependency changes. +> More information: . + +- Rebuild a specific package: + +`npm {{[rb|rebuild]}} {{package}}` + +- Rebuild all installed packages: + +`npm {{[rb|rebuild]}}` + +- Rebuild with verbose output: + +`npm {{[rb|rebuild]}} --verbose` + +- Rebuild a package in a specific directory: + +`npm {{[rb|rebuild]}} --prefix {{path/to/dir}} {{package}}` + +- Rebuild without using the npm cache: + +`npm {{[rb|rebuild]}} --no-cache` + +- Rebuild in global mode: + +`npm {{[rb|rebuild]}} {{[-g|--global]}}` diff --git a/tldr/osx/head b/tldr/osx/head index a5fe925f..104dc583 100644 --- a/tldr/osx/head +++ b/tldr/osx/head @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Output the first part of files. > More information: . -- Output the first few lines of a file: +- Output the first 10 lines of a file: -`head {{[-n|--lines]}} {{8}} {{path/to/file}}` +`head {{path/to/file}}` -- Output the first few bytes of a file: +- Output the first 5 lines of multiple files: -`head {{[-c|--bytes]}} {{8}} {{path/to/file}}` +`head {{[-5|--lines 5]}} {{path/to/file1 path/to/file2 ...}}` -- Output everything but the last few lines of a file: +- Output the first `count` lines of a file: -`head {{[-n|--lines]}} -{{8}} {{path/to/file}}` +`head {{[-n|--lines]}} {{count}} {{path/to/file}}` -- Output everything but the last few bytes of a file: +- Output the first n `bytes` of a file: -`head {{[-c|--bytes]}} -{{8}} {{path/to/file}}` +`head {{[-c|--bytes]}} {{bytes}} {{path/to/file}}` diff --git a/tldr/osx/tail b/tldr/osx/tail index 2e0eddb9..5f5fdf74 100644 --- a/tldr/osx/tail +++ b/tldr/osx/tail @@ -9,9 +9,9 @@ source: https://github.com/tldr-pages/tldr.git > See also: `head`. > More information: . -- Show last 'count' lines in file: +- Show last 8 lines in file: -`tail -n {{8}} {{path/to/file}}` +`tail -n 8 {{path/to/file}}` - Print a file from a specific line number: diff --git a/tldr/osx/valet b/tldr/osx/valet index 1b2d8c0f..a5c2c1b6 100644 --- a/tldr/osx/valet +++ b/tldr/osx/valet @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # valet -> A Laravel development environment that allows hosting sites via local tunnels on `http://.test`. +> A Laravel development environment that allows hosting sites via local tunnels on `http://example.test`. > More information: . - Start the valet daemon: @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `valet park` -- View 'parked' paths: +- View "parked" paths: `valet paths` diff --git a/tldr/poetry-shell b/tldr/poetry-shell new file mode 100644 index 00000000..6448d249 --- /dev/null +++ b/tldr/poetry-shell @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry shell + +> Spawn a shell within the virtual environment. +> Note: The `shell` command was moved to a plugin: `poetry-plugin-shell`. +> More information: . + +- Spawn a shell within the virtual environment: + +`poetry shell` diff --git a/tldr/screenfetch b/tldr/screenfetch index ba6cd571..a70b2b1f 100644 --- a/tldr/screenfetch +++ b/tldr/screenfetch @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `screenfetch` -- Take a screenshot (requires 'scrot'): +- Take a screenshot (requires `scrot`): `screenfetch -s` diff --git a/tldr/tail b/tldr/tail index 58656cbb..5bc8f80a 100644 --- a/tldr/tail +++ b/tldr/tail @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `tail {{path/to/file1 path/to/file2 ...}}` -- Show last 'count' lines in file: +- Show last `count` lines in file: `tail {{[-n|--lines]}} {{count}} {{path/to/file}}` diff --git a/tldr/tree b/tldr/tree index ac950b99..cad71c62 100644 --- a/tldr/tree +++ b/tldr/tree @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Show the contents of the current directory as a tree. > More information: . -- Print files and directories up to 'num' levels of depth (where 1 means the current directory): +- Print files and directories up to `num` levels of depth (where 1 means the current directory): `tree -L {{num}}` diff --git a/tldr/tv b/tldr/tv new file mode 100644 index 00000000..b7e4622b --- /dev/null +++ b/tldr/tv @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tv + +> Cross-platform, fast, extensible fuzzy-finder tool. +> Works with “channels” (e.g., files, env, git repos) or from `stdin`. +> More information: . + +- Launch with the default channel: + +`tv` + +- Open a specific channel: + +`tv {{files|env|git-repos|...}}` + +- List all available channels: + +`tv list-channels` + +- Fuzzy-pick from lines piped on `stdin`: + +`{{command}} | tv` + +- Pipe and show a live preview for each entry: + +`{{command}} | tv --preview '{{preview_command}}'` + +- Build a picker from commands (source + preview): + +`tv --source-command '{{source_command}}' --preview-command '{{preview_command}}' --preview-size {{70}}` + +- Update and install community-maintained channels: + +`tv update-channels`