diff --git a/tldr/file b/tldr/file index 882fdca5..7348aed7 100644 --- a/tldr/file +++ b/tldr/file @@ -8,13 +8,13 @@ source: https://github.com/tldr-pages/tldr.git > Determine file type. > More information: . -- Give a description of the type of the specified file. Works fine for files with no file extension: +- Give a description of the type of the specified file: `file {{path/to/file}}` - Look inside a zipped file and determine the file type(s) inside: -`file {{[-z|--uncompress]}} {{foo.zip}}` +`file {{[-z|--uncompress]}} {{path/to/file.zip}}` - Allow file to work with special or device files: diff --git a/tldr/flox b/tldr/flox new file mode 100644 index 00000000..236f7727 --- /dev/null +++ b/tldr/flox @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flox + +> Easy to use Nix package and environment manager. +> More information: . + +- Create a new environment in the current directory: + +`flox init` + +- Enter an environment, or create one if it doesn't exist: + +`flox activate` + +- Search for packages in the FloxHub catalog: + +`flox search {{package}}` + +- Install a package into the current environment: + +`flox {{[i|install]}} {{package}}` + +- Uninstall a package from the current environment: + +`flox uninstall {{package}}` + +- View a list of all packages installed in the current environment: + +`flox {{[l|list]}}` + +- Push a local environment to FloxHub to share with others: + +`flox push` + +- Pull a shared environment from FloxHub: + +`flox pull {{environment_name}}` diff --git a/tldr/get_iplayer b/tldr/get_iplayer new file mode 100644 index 00000000..c893ca7f --- /dev/null +++ b/tldr/get_iplayer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# get_iplayer + +> Indexing tool and personal video recorder for BBC iPlayer and BBC Sounds. +> More information: . + +- Search programmes by name: + +`get_iplayer "{{program_name}}"` + +- Record programme by results of search: + +`get_iplayer "{{program_name}}" {{[-g|--get]}}` + +- Record programme by URL from the BBC iPlayer website: + +`get_iplayer "https://www.bbc.co.uk/iplayer/episode/{{program_PID}}/{{name-of-show-episode-number-episode-title}}"` + +- Download subtitles for a programme by results of search: + +`get_iplayer "{{program_name}}" --subtitles-only` + +- Search for a programme, record it and download subtitles: + +`get_iplayer "{{program_name}}" {{[-g|--get]}} --subtitles` + +- Display help: + +`get_iplayer {{[-h|--help]}}` diff --git a/tldr/git-stash b/tldr/git-stash index eae2d00d..6b54abf9 100644 --- a/tldr/git-stash +++ b/tldr/git-stash @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Stash current changes with a message, except new (untracked) files: -`git stash push {{[-m|--message]}} {{optional_stash_message}}` +`git stash push {{[-m|--message]}} {{stash_message}}` - Stash current changes, including new untracked files: @@ -28,11 +28,11 @@ source: https://github.com/tldr-pages/tldr.git `git stash show {{[-p|--patch]}} {{stash@{0}}}` -- Apply a stash (default is the latest, named stash@{0}): +- Apply a stash (default is the latest, named `stash@{0}`): `git stash apply {{optional_stash_name_or_commit}}` -- Drop or apply a stash (default is stash@{0}) and remove it from the stash list if applying doesn't cause conflicts: +- Drop or apply a stash (default is `stash@{0}`) and remove it from the stash list if applying doesn't cause conflicts: `git stash pop {{optional_stash_name}}` diff --git a/tldr/git-tag b/tldr/git-tag index af1c0088..fc06ff6e 100644 --- a/tldr/git-tag +++ b/tldr/git-tag @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `git push origin tag {{tag_name}}` -- List all tags whose ancestors include a given commit: +- List all tags which contain a given commit (HEAD if not specified): `git tag --contains {{commit}}` diff --git a/tldr/linux/aur-sync b/tldr/linux/aur-sync new file mode 100644 index 00000000..5adc5582 --- /dev/null +++ b/tldr/linux/aur-sync @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aur sync + +> Download and build AUR packages automatically. +> Note: A local repository needs to be defined in `/etc/pacman.conf` and `vifm` needs to be installed for this to fully function. +> More information: . + +- Download one or more packages and their dependencies from the AUR, build them, and add them to a local repository: + +`aur sync {{package1 package2 ...}}` + +- Upgrade local repository packages: + +`aur sync {{[-u|--upgrades]}}` + +- Clean build files after install: + +`aur sync {{[-C|--clean]}} {{package}}` + +- Install a package without viewing changes in Vim and do not confirm dependency installation: + +`aur sync --noview {{[-n|--noconfirm]}} {{package}}` + +- Ignore specific packages when upgrading: + +`aur sync {{[-u|--upgrades]}} --ignore {{package1,package2,...}}` diff --git a/tldr/linux/systemctl-cat b/tldr/linux/systemctl-cat new file mode 100644 index 00000000..1c768e65 --- /dev/null +++ b/tldr/linux/systemctl-cat @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl cat + +> Show the full contents of unit files as systemd sees them. +> More information: . + +- Show the contents and absolute path of a unit file: + +`systemctl cat {{unit}}` + +- Show the contents of multiple unit files: + +`systemctl cat {{unit1 unit2 ...}}` + +- Show the contents of a unit file for a template: + +`systemctl cat {{template@}}` diff --git a/tldr/linux/updatectl b/tldr/linux/updatectl index 379bffd6..0b7f1815 100644 --- a/tldr/linux/updatectl +++ b/tldr/linux/updatectl @@ -8,15 +8,19 @@ source: https://github.com/tldr-pages/tldr.git > System update utility. > More information: . -- Apply an update: +- Check to see if the system has any available updates: -`updatectl update {{target}}` +`updatectl check` -- Apply update and then reboot system: +- Update to the latest version: -`updatectl --reboot update {{target}}` +`updatectl update` -- Show data about the target and its versions: +- Show update targets: + +`updatectl list` + +- Show data about a target and its versions: `updatectl list {{target}}` @@ -24,13 +28,9 @@ source: https://github.com/tldr-pages/tldr.git `updatectl --offline list {{target}}` -- Suppress data headers for returned information: +- Apply an update to a target and then reboot the system: -`updatectl --no-legend list {{target}}` - -- Check to see if a target has any available updates: - -`updatectl check {{target}}` +`updatectl --reboot update {{target}}` - Clean up old versions of a specified target: diff --git a/tldr/nuclei b/tldr/nuclei index af942517..95fcb377 100644 --- a/tldr/nuclei +++ b/tldr/nuclei @@ -5,37 +5,38 @@ source: https://github.com/tldr-pages/tldr.git --- # nuclei -> Fast and customizable vulnerability scanner based on a simple YAML based DSL. +> Fast and customizable vulnerability scanner using a simple YAML-based DSL. > More information: . -- [u]pdate `nuclei` [t]emplates to the latest released version (will be downloaded to `~/nuclei-templates`): +- Update `nuclei` templates to the latest released version (downloaded to `~/nuclei-templates` on macOS/Linux or `%USERPROFILE% +uclei-templates` on Windows): `nuclei {{[-ut|-update-templates]}}` -- [l]ist all [t]emplates with a specific [p]rotocol [t]ype: +- [l]ist all [t]emplates by specific [p]rotocol [t]ype: `nuclei -tl {{[-pt|-type]}} {{dns|file|http|headless|tcp|workflow|ssl|websocket|whois|code|javascript}}` -- Run an [a]utomatic web [s]can using wappalyzer technology detection specifying a target [u]RL/host to scan: +- Run an automatic web scan using Wappalyzer technology detection for a specific target [u]RL/host: -`nuclei {{[-as|-automatic-scan]}} {{[-u|-target]}} {{scanme.nmap.org}}` +`nuclei {{[-as|-automatic-scan]}} {{[-u|-target]}} {{example.com}}` -- Run HTTP [p]rotocol [t]ype templates of high and critical severity, [e]xporting results to [m]arkdown files inside a specific directory: +- Run HTTP [p]rotocol [t]ype templates of specific severity, exporting results to markdown files inside a specific directory: -`nuclei {{[-s|-severity]}} high,critical {{[-pt|-type]}} http {{[-u|-target]}} {{http://example.com}} {{[-me|-markdown-export]}} {{markdown_directory}}` +`nuclei {{[-s|-severity]}} {{high,critical,...}} {{[-pt|-type]}} http {{[-u|-target]}} {{https://example.com}} {{[-me|-markdown-export]}} {{path/to/directory}}` -- Run all templates using a different [r]ate [l]imit and maximum [b]ulk [s]ize with silent output (only showing the findings): +- Run all templates with a custom rate limit, maximum bulk size, and silent output (only findings shown): -`nuclei {{[-rl|-rate-limit]}} {{150}} {{[-bs|-bulk-size]}} {{25}} {{[-c|-concurrency]}} {{25}} -silent {{[-u|-target]}} {{http://example.com}}` +`nuclei {{[-rl|-rate-limit]}} {{150}} {{[-bs|-bulk-size]}} {{25}} {{[-c|-concurrency]}} {{25}} -silent {{[-u|-target]}} {{https://example.com}}` -- Run the WordPress [w]orkflow against a WordPress site: +- Run a specific nuclei-bundled workflow against a target: -`nuclei {{[-w|-workflows]}} {{path/to/nuclei-templates/workflows/wordpress-workflow.yaml}} {{[-u|-target]}} {{https://example.com}}` +`nuclei {{[-w|-workflows]}} {{workflows/wordpress-workflow.yaml}} {{[-u|-target]}} {{https://example.com}}` -- Run one or more specific [t]emplates or directory with [t]emplates with [v]erbose output in `stderr` and [o]utput detected issues/vulnerabilities to a file: +- Run one or more specific templates or directory with templates with verbose output in `stderr` and output detected issues/vulnerabilities to a file: -`nuclei {{[-t|-templates]}} {{path/to/nuclei-templates/http}} {{[-u|-target]}} {{http://example.com}} {{[-v|-verbose]}} {{[-o|-output]}} {{results}}` +`nuclei {{[-t|-templates]}} {{path/to/nuclei-templates/http}} {{[-u|-target]}} {{https://example.com}} {{[-v|-verbose]}} {{[-o|-output]}} {{path/to/results}}` -- Run scan based on one or more [t]emplate [c]onditions: +- Run a scan based on one or more template conditions: `nuclei {{[-tc|-template-condition]}} "{{contains(tags, 'xss') && contains(tags, 'cve')}}" {{[-u|-target]}} {{https://example.com}}`