diff --git a/tldr/aws-google-auth b/tldr/aws-google-auth index 074c9f43..aad656f7 100644 --- a/tldr/aws-google-auth +++ b/tldr/aws-google-auth @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # aws-google-auth -> Command-line tool to acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On) provider. +> Acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On) provider. > More information: . - Log in with Google SSO using the specified [u]sername [I]DP and [S]P identifiers and set the credentials [d]uration to one hour: diff --git a/tldr/blackfire b/tldr/blackfire index 6219f037..426dfd1c 100644 --- a/tldr/blackfire +++ b/tldr/blackfire @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # blackfire -> A command-line profiling tool for PHP. +> Monitor, profile and test a PHP application. > More information: . - Initialize and configure the Blackfire client: diff --git a/tldr/convert b/tldr/convert index 95e0878c..794d525c 100644 --- a/tldr/convert +++ b/tldr/convert @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # convert -> Image conversion tool. +> Convert between image formats, scale, join, and create images, and much more. > Part of ImageMagick. > More information: . diff --git a/tldr/docker-rm b/tldr/docker-rm index 6e090481..749d33fd 100644 --- a/tldr/docker-rm +++ b/tldr/docker-rm @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`docker rm` +`docker rm --help` diff --git a/tldr/git-secret b/tldr/git-secret index 0115ef02..2c2aec32 100644 --- a/tldr/git-secret +++ b/tldr/git-secret @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # git secret -> Bash tool which stores private data inside a Git repository. +> Stores private data inside a Git repository. Written in Bash. > More information: . - Initialize `git-secret` in a local repository: diff --git a/tldr/gyb b/tldr/gyb index 8ac67bbe..2487a3fb 100644 --- a/tldr/gyb +++ b/tldr/gyb @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # gyb -> Command line tool for locally backing up Gmail messages using Gmail's API over HTTPS. +> Locally back up Gmail messages using Gmail's API over HTTPS. > More information: . - Estimate the number and the size of all emails on your Gmail account: diff --git a/tldr/jenv b/tldr/jenv index a4f65e50..120e4ab5 100644 --- a/tldr/jenv +++ b/tldr/jenv @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # jenv -> Command-line tool to manage the "JAVA_HOME" environment variable. +> Manage the "JAVA_HOME" environment variable. > More information: . - Add a Java version to jEnv: diff --git a/tldr/json5 b/tldr/json5 index 76da67bb..eb6bee0b 100644 --- a/tldr/json5 +++ b/tldr/json5 @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # json5 -> A command-line tool for converting JSON5 files to JSON. +> Convert JSON5 files to JSON. > More information: . - Convert JSON5 `stdin` to JSON `stdout`: diff --git a/tldr/k8s-unused-secret-detector b/tldr/k8s-unused-secret-detector index e326191b..81988c00 100644 --- a/tldr/k8s-unused-secret-detector +++ b/tldr/k8s-unused-secret-detector @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # k8s-unused-secret-detector -> Command-line interface tool for detecting unused Kubernetes secrets. +> Detect unused Kubernetes secrets. > More information: . - Detect unused secrets: diff --git a/tldr/k8sec b/tldr/k8sec index 93e9c888..56d2878a 100644 --- a/tldr/k8sec +++ b/tldr/k8sec @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # k8sec -> Command-line interface tool to manage Kubernetes secrets. +> Manage Kubernetes secrets. > More information: . - List all secrets: diff --git a/tldr/linux/ausyscall b/tldr/linux/ausyscall index cfd96670..7bb89d32 100644 --- a/tldr/linux/ausyscall +++ b/tldr/linux/ausyscall @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # ausyscall -> Program that allows mapping syscall names and numbers. +> Map syscall names and numbers. > More information: . - Display syscall number of a specific system call: diff --git a/tldr/linux/betterdiscordctl b/tldr/linux/betterdiscordctl index 1c4f2a24..c681d1ee 100644 --- a/tldr/linux/betterdiscordctl +++ b/tldr/linux/betterdiscordctl @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # betterdiscordctl -> A program for managing BetterDiscord on Linux. +> Manage BetterDiscord on Linux. > More information: . - Install BetterDiscord on Discord Stable: diff --git a/tldr/linux/bspc b/tldr/linux/bspc index 2efa1be8..581886b1 100644 --- a/tldr/linux/bspc +++ b/tldr/linux/bspc @@ -5,12 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # bspc -> A tool to control `bspwm`. +> Configure and control `bspwm`, managing nodes, desktops, monitors, and more. +> See also: `bspwm`. > More information: . -- Define two virtual desktop: +- Define two virtual desktops: -`bspc monitor --reset-desktops {{1}} {{2}}` +`bspc monitor --reset-desktops {{desktop_name1}} {{desktop_name2}}` - Focus the given desktop: @@ -27,3 +28,7 @@ source: https://github.com/tldr-pages/tldr.git - Toggle full screen mode for the selected node: `bspc node --state ~fullscreen` + +- Set the value of a specific setting: + +`bspc config {{setting_name}} {{value}}` diff --git a/tldr/linux/bspwm b/tldr/linux/bspwm index 8a162d4d..09297d22 100644 --- a/tldr/linux/bspwm +++ b/tldr/linux/bspwm @@ -6,12 +6,9 @@ source: https://github.com/tldr-pages/tldr.git # bspwm > A tiling window manager based on binary space partitioning. +> See also: `bspc`, for controlling it. > More information: . - Start `bspwm` (note that a pre-existing window manager must not be open when this command is run): `bspwm -c {{path/to/config}}` - -- View documentation for `bspc`: - -`tldr bspc` diff --git a/tldr/linux/btrbk b/tldr/linux/btrbk index b1704835..495a69b2 100644 --- a/tldr/linux/btrbk +++ b/tldr/linux/btrbk @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # btrbk -> A tool for creating snapshots and remote backups of btrfs subvolumes. +> Create snapshots and remote backups of btrfs subvolumes. > More information: . - Print statistics about configured subvolumes and snapshots: diff --git a/tldr/linux/cfdisk b/tldr/linux/cfdisk index f7922cbf..c7784d9b 100644 --- a/tldr/linux/cfdisk +++ b/tldr/linux/cfdisk @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # cfdisk -> A program for managing partition tables and partitions on a hard disk using a curses UI. +> Manage partition tables and partitions on a hard disk using a curses UI. > More information: . - Start the partition manipulator with a specific device: diff --git a/tldr/linux/cpufreq-info b/tldr/linux/cpufreq-info index 1ebcd8b4..08114ea5 100644 --- a/tldr/linux/cpufreq-info +++ b/tldr/linux/cpufreq-info @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # cpufreq-info -> A tool to show CPU frequency information. +> Show CPU frequency information. > More information: . - Show CPU frequency information for all CPUs: diff --git a/tldr/linux/dpkg-query b/tldr/linux/dpkg-query index 86587629..54ce28d1 100644 --- a/tldr/linux/dpkg-query +++ b/tldr/linux/dpkg-query @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # dpkg-query -> A tool that shows information about installed packages. +> Display information about installed packages. > More information: . - List all installed packages: diff --git a/tldr/linux/fdisk b/tldr/linux/fdisk index de6165d8..3a455a24 100644 --- a/tldr/linux/fdisk +++ b/tldr/linux/fdisk @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # fdisk -> A program for managing partition tables and partitions on a hard disk. +> Manage partition tables and partitions on a hard disk. > See also: `partprobe`. > More information: . diff --git a/tldr/linux/fwupdmgr b/tldr/linux/fwupdmgr index bfa28295..3412d384 100644 --- a/tldr/linux/fwupdmgr +++ b/tldr/linux/fwupdmgr @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # fwupdmgr -> A tool for updating device firmware, including UEFI, using `fwupd`. +> Update device firmware, including UEFI, using `fwupd`. > More information: . - Display all devices detected by fwupd: diff --git a/tldr/linux/gdebi b/tldr/linux/gdebi index db282f2e..1b4ed7e5 100644 --- a/tldr/linux/gdebi +++ b/tldr/linux/gdebi @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # gdebi -> Simple tool to install `.deb` files. +> Easily install `.deb` files. > More information: . - Install local `.deb` packages resolving and installing its dependencies: diff --git a/tldr/linux/grubby b/tldr/linux/grubby new file mode 100644 index 00000000..34a74dbd --- /dev/null +++ b/tldr/linux/grubby @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grubby + +> Tool for configuring `grub` and `zipl` bootloaders. +> More information: . + +- Add kernel boot arguments to all kernel menu entries: + +`sudo grubby --update-kernel=ALL --args '{{quiet console=ttyS0}}'` + +- Remove existing arguments from the entry for the default kernel: + +`sudo grubby --update-kernel=DEFAULT --remove-args {{quiet}}` + +- List all kernel menu entries: + +`sudo grubby --info=ALL` diff --git a/tldr/linux/ipset b/tldr/linux/ipset index 703ea79a..4de0f079 100644 --- a/tldr/linux/ipset +++ b/tldr/linux/ipset @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # ipset -> A tool to create IP sets for firewall rules. +> Create IP sets for firewall rules. > More information: . - Create an empty IP set which will contain IP addresses: diff --git a/tldr/linux/minicom b/tldr/linux/minicom index f19c032e..8d285d7b 100644 --- a/tldr/linux/minicom +++ b/tldr/linux/minicom @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # minicom -> A program to communicate with the serial interface of a device. +> Communicate with the serial interface of a device. > More information: . - Open a given serial port: diff --git a/tldr/linux/navi b/tldr/linux/navi new file mode 100644 index 00000000..a7d548b6 --- /dev/null +++ b/tldr/linux/navi @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# navi + +> An interactive cheatsheet tool for the command line and application launchers. +> More information: . + +- Browse through all available cheatsheets: + +`navi` + +- Browse the cheatsheet for `navi` itself: + +`navi fn welcome` + +- Print a command from the cheatsheet without executing it: + +`navi --print` + +- Output shell widget source code (It automatically detects your shell if possible, but can also be specified manually): + +`navi widget {{shell}}` + +- Autoselect and execute the snippet that best matches a query: + +`navi --query '{{query}}' --best-match` diff --git a/tldr/linux/select b/tldr/linux/select index c0b10cfc..8f882e3b 100644 --- a/tldr/linux/select +++ b/tldr/linux/select @@ -12,9 +12,13 @@ source: https://github.com/tldr-pages/tldr.git `select {{word}} in {{apple}} {{orange}} {{pear}} {{banana}}; do echo ${{word}}; done` -- Create a menu for picking a file or folder from the current directory: +- Create a menu from the output of another command: -`select {{file}} in *; do echo ${{file}}; done` +`select {{line}} in $({{command}}); do echo ${{line}}; done` + +- Specify the prompt string for `select` and create a menu for picking a file or folder from the current directory: + +`PS3="{{Select a file: }}"; select {{file}} in *; do echo ${{file}}; done` - Create a menu from a Bash array: diff --git a/tldr/linux/update-alternatives b/tldr/linux/update-alternatives index 05aaa352..8874ca03 100644 --- a/tldr/linux/update-alternatives +++ b/tldr/linux/update-alternatives @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # update-alternatives -> A convenient tool for maintaining symbolic links to determine default commands. +> Convenientily maintain symbolic links to determine default commands. > More information: . - Add a symbolic link: diff --git a/tldr/lpr b/tldr/lpr index 6feaa967..3f707da0 100644 --- a/tldr/lpr +++ b/tldr/lpr @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # lpr -> CUPS tool for printing files. +> Print files. > See also: `lpstat` and `lpadmin`. > More information: . diff --git a/tldr/minifab b/tldr/minifab index fc879aba..75a23d57 100644 --- a/tldr/minifab +++ b/tldr/minifab @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # minifab -> Utility tool that automates the setup and deployment of Hyperledger Fabric networks. +> Automate the setup and deployment of Hyperledger Fabric networks. > More information: . - Bring up the default Hyperledger Fabric network: diff --git a/tldr/nativefier b/tldr/nativefier index ad0e4634..2cfa2820 100644 --- a/tldr/nativefier +++ b/tldr/nativefier @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # nativefier -> Command-line tool to create a desktop app for any web site with minimal configuration. +> Create a desktop app for any web site with minimal configuration. > More information: . - Make a desktop app for a website: diff --git a/tldr/nest b/tldr/nest index f7fbdb61..049c5e8a 100644 --- a/tldr/nest +++ b/tldr/nest @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # nest -> Command-line tool to initialize, develop, and maintain Nest applications. +> Initialize, develop, and maintain Nest applications. > More information: . - Display information about installed nest version: diff --git a/tldr/osx/archey b/tldr/osx/archey index cf069b87..2459a24e 100644 --- a/tldr/osx/archey +++ b/tldr/osx/archey @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # archey -> Simple tool for stylishly displaying system information. +> Stylishly display system information. > More information: . - Show system information: diff --git a/tldr/osx/shuf b/tldr/osx/shuf index 8060bd6b..c43de97b 100644 --- a/tldr/osx/shuf +++ b/tldr/osx/shuf @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `shuf {{filename}} --output={{output_filename}}` -- Generate random numbers in range 1-10: +- Generate random numbers in the range 1 to 10: `shuf --input-range={{1-10}}` diff --git a/tldr/osx/wacaw b/tldr/osx/wacaw index b7edd607..522c6b63 100644 --- a/tldr/osx/wacaw +++ b/tldr/osx/wacaw @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # wacaw -> Command-line tool for macOS to capture both still pictures and video from an attached camera. +> Capture both still pictures and video from an attached camera. > More information: . - Take a picture from webcam: diff --git a/tldr/tokei b/tldr/tokei index 587c761c..341062cd 100644 --- a/tldr/tokei +++ b/tldr/tokei @@ -5,21 +5,21 @@ source: https://github.com/tldr-pages/tldr.git --- # tokei -> A program that prints out statistics about code. +> Display statistics about code. > More information: . -- Get a report on the code in a directory and all subdirectories: +- Display a report for the code in a directory and all subdirectories: `tokei {{path/to/directory}}` -- Get a report for a directory excluding `.min.js` files: +- Display a report for a directory excluding `.min.js` files: `tokei {{path/to/directory}} -e {{*.min.js}}` -- Print out statistics for individual files in a directory: +- Display statistics for individual files in a directory: `tokei {{path/to/directory}} --files` -- Get a report for all files of type Rust and Markdown: +- Display a report for all files of type Rust and Markdown: `tokei {{path/to/directory}} -t={{Rust}},{{Markdown}}` diff --git a/tldr/trufflehog b/tldr/trufflehog new file mode 100644 index 00000000..50beb7c5 --- /dev/null +++ b/tldr/trufflehog @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trufflehog + +> Find and verify credentials in files, Git repositories, S3 buckets, and Docker images. +> More information: . + +- Scan a Git repository for verified secrets: + +`trufflehog git {{https://github.com/trufflesecurity/test_keys}} --only-verified` + +- Scan a GitHub organization for verified secrets: + +`trufflehog github --org={{trufflesecurity}} --only-verified` + +- Scan a GitHub repository for verified keys and get JSON output: + +`trufflehog git {{https://github.com/trufflesecurity/test_keys}} --only-verified --json` + +- Scan a GitHub repository along with its Issues and Pull Requests: + +`trufflehog github --repo={{https://github.com/trufflesecurity/test_keys}} --issue-comments --pr-comments` + +- Scan an S3 bucket for verified keys: + +`trufflehog s3 --bucket={{bucket name}} --only-verified` + +- Scan S3 buckets using IAM Roles: + +`trufflehog s3 --role-arn={{iam-role-arn}}` + +- Scan individual files or directories: + +`trufflehog filesystem {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Scan a Docker image for verified secrets: + +`trufflehog docker --image {{trufflesecurity/secrets}} --only-verified` diff --git a/tldr/windows/gpupdate b/tldr/windows/gpupdate index ae6e57fe..91588cec 100644 --- a/tldr/windows/gpupdate +++ b/tldr/windows/gpupdate @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # gpupdate -> A tool to check and apply Windows Group Policy settings. +> Check and apply Windows Group Policy settings. > More information: . - Check and apply updated Group Policy settings: diff --git a/tldr/zip2john b/tldr/zip2john index 0d6514d0..6246e9bf 100644 --- a/tldr/zip2john +++ b/tldr/zip2john @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zip2john -> A tool to extract password hashes from `zip` archives for use with John the Ripper password cracker. +> Extract password hashes from `zip` archives for use with John the Ripper password cracker. > This is a utility tool usually installed as part of the John the Ripper installation. > More information: .