Update cheatsheets

This commit is contained in:
ivuorinen
2024-10-02 00:17:10 +00:00
parent c03ad03251
commit 6db54f9410
23 changed files with 500 additions and 1 deletions

29
tldr/$ Normal file
View File

@@ -0,0 +1,29 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# Dollar sign
> Expand a bash variable.
> More information: <https://gnu.org/software/bash/manual/bash.html#Shell-Variables>.
- Print a variable:
`echo ${{VARIABLE}}`
- Print the exit status of the previous command:
`echo $?`
- Print a random number between 0 and 32767:
`echo $RANDOM`
- Print one of the prompt strings:
`echo ${{PS1|PS2|PS3|PS4}}`
- Expand with the output of `command` and run it. Same as enclosing `command` in backtics:
`$({{command}})`

View File

@@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git
# ghdl
> Open-source simulator for the VHDL language.
> More information: <http://ghdl.free.fr>.
> More information: <https://ghdl.github.io/ghdl/>.
- Analyze a VHDL source file and produce an object file:

25
tldr/greater-than Normal file
View File

@@ -0,0 +1,25 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# Greater than
> Redirect output to a file.
> More information: <https://gnu.org/software/bash/manual/bash.html#Redirecting-Output>.
- Redirect `stdout` to a file:
`{{command}} > {{path/to/file}}`
- Append to a file:
`{{command}} >> {{path/to/file}}`
- Redirect both `stdout` and `stderr` to a file:
`{{command}} &> {{path/to/file}}`
- Redirect both `stdout` and `stderr` to `/dev/null` to keep the terminal output clean:
`{{command}} &> /dev/null`

14
tldr/less-than Normal file
View File

@@ -0,0 +1,14 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# Less than
> Redirect a file to `stdin`.
> Achieves the same effect as `cat file.txt |`.
> More information: <https://gnu.org/software/bash/manual/bash.html#Redirecting-Input>.
- Redirect a file to `stdin`:
`{{command}} < {{path/to/file.txt}}`

29
tldr/linux/apt-clone Normal file
View File

@@ -0,0 +1,29 @@
---
syntax: markdown
tags: [tldr, linux]
source: https://github.com/tldr-pages/tldr.git
---
# apt-clone
> Clone/backup/restore the package state of a Debian-based system.
> More information: <https://github.com/mvo5/apt-clone>.
- Clone the package state of the current system into a specified directory:
`apt-clone clone {{path/to/directory}}`
- Create a clone file (`tar.gz`) for backup purposes:
`apt-clone clone --destination {{path/to/backup.tar.gz}}`
- Restore the package state from a clone file:
`apt-clone restore {{path/to/backup.tar.gz}}`
- Show information about a clone file (e.g., the release, architecture):
`apt-clone info {{path/to/backup.tar.gz}}`
- Check if the clone file can be restored on the current system:
`apt-clone restore {{path/to/backup.tar.gz}} --destination {{path/to/restore}}`

17
tldr/vertical-bar Normal file
View File

@@ -0,0 +1,17 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# Vertical bar
> Pipe data between programs.
> More information: <https://gnu.org/software/bash/manual/bash.html#Pipelines>.
- Pipe `stdout` to `stdin`:
`{{command}} | {{command}}`
- Pipe both `stdout` and `stderr` to `stdin`:
`{{command}} |& {{command}}`

29
tldr/vinmap Normal file
View File

@@ -0,0 +1,29 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# vinmap
> A multithreaded Nmap scanner that splits IP ranges into chunks, performs parallel scans, and merges XML or JSON results.
> More information: <https://pypi.org/project/vinmap>.
- Perform a basic scan of a subnet:
`vinmap -ip {{192.168.1.0/24}}`
- Scan a domain with version and OS detection, saving results to a specific file:
`vinmap -ip {{example.com}} -s "-sV -O" -o {{path/to/scan_results.xml}}`
- Scan an IP range using 10 chunks and 20 concurrent threads, uses half of the system's CPU cores if not specified:
`vinmap -ip {{10.0.0.1-10.0.0.255}} -n 10 -t 20`
- Output scan results in JSON format:
`vinmap -ip {{192.168.1.1-192.168.1.100}} -f json`
- Scan multiple IPs with default settings and save merged XML output:
`vinmap -ip {{192.168.1.1,192.168.1.2,...}}`

38
tldr/yadm Executable file
View File

@@ -0,0 +1,38 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm
> A dotfiles manager that works by using `git`.
> Some subcommands such as `init`, `clone`, `push`, and `pull` have their own usage documentation.
> More information: <https://yadm.io/docs/overview>.
- Override the `yadm` directory. `yadm` stores its configurations relative to this directory:
`yadm --yadm-dir`
- Override the `yadm` data directory: `yadm` stores its data relative to this directory:
`yadm --yadm-data`
- Override the location of the `yadm` repository:
`yadm --yadm-repo`
- Override the location of the `yadm` configuration file:
`yadm --yadm-config`
- Override the location of the `yadm` encryption configuration:
`yadm --yadm-encrypt`
- Override the location of the `yadm` encrypted files archive:
`yadm --yadm-archive`
- Override the location of the `yadm` bootstrap program:
`yadm --yadm-bootstrap`

14
tldr/yadm-alt Executable file
View File

@@ -0,0 +1,14 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-alt
> Create symbolic links and process templates for any managed files.
> Learn more about templates: <https://yadm.io/docs/templates>.
> More information: <https://yadm.io/docs/alternates>.
- Create symbolic links between alternate files manually:
`yadm alt`

14
tldr/yadm-bootstrap Executable file
View File

@@ -0,0 +1,14 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-bootstrap
> Execute Yadm's bootstrap file.
> This file should be created in `$HOME/.config/yadm/bootstrap`.
> More information: <https://yadm.io/docs/bootstrap>.
- Execute bootstrap executable:
`yadm bootstrap`

35
tldr/yadm-clone Executable file
View File

@@ -0,0 +1,35 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-clone
> Works just like `git clone`. In addition you can pass extra flags to configure your repository.
> If there is a bootstrap file in the repository, you will be prompted to execute it.
> See also: `git clone`.
> More information: <https://yadm.io/docs/common_commands>.
- Clone an existing repository:
`yadm clone {{remote_repository_location}}`
- Clone an existing repository, then execute the bootstrap file:
`yadm clone {{remote_repository_location}} --bootstrap`
- Clone an existing repository and after cloning, do not execute the bootstrap file:
`yadm clone {{remote_repository_location}} --no-bootstrap`
- Change the worktree that `yadm` will use during cloning:
`yadm clone {{remote_repository_location}} --w {{worktree_file}}`
- Change the branch that `yadm` gets files from:
`yadm clone {{remote_repository_location}} -b {{branch}}`
- Override an existing repository local branch:
`yadm clone {{remote_repository_location}} -f`

25
tldr/yadm-config Executable file
View File

@@ -0,0 +1,25 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-config
> Pass options to `yadm`'s config file. Change the `.config` of the repository managed by `yadm`.
> See also: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#configuration>.
- Set or update a `yadm`'s Git configuration:
`yadm config {{key.inner-key}} {{value}}`
- Get a value from `yadm`'s Git configuration:
`yadm config --get {{key}}`
- Unset a value in `yadm`'s Git configuration:
`yadm config --unset {{key}}`
- List all values in `yadm`'s Git configuration:
`yadm config --list`

14
tldr/yadm-decrypt Executable file
View File

@@ -0,0 +1,14 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-decrypt
> Decrypt files that were encrypted by `yadm`.
> When activating this command you will be prompted for a password.
> More information: <https://yadm.io/docs/encryption>.
- Decrypt files:
`yadm decrypt`

18
tldr/yadm-encrypt Executable file
View File

@@ -0,0 +1,18 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-encrypt
> Encrypt files listed in the designated encrypt file.
> After the files are encrypted they will be save in the designated archive folder.
> More information: <https://yadm.io/docs/encryption>.
- Encrypt files listed in the designated encrypt file:
`yadm encrypt`
- Create the necessary files and folders for encryption:
`touch {{path/to/encrypt_file}} && mkdir {{path/to/archive_folder}}`

18
tldr/yadm-enter Executable file
View File

@@ -0,0 +1,18 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-enter
> Run a sub-shell with all Git variables set. This sub-shell can be used to easily interact with the local `yadm` repository using Git commands.
> This could be useful if you are using a tool which uses Git directly.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>.
- Run a sub-shell with all Git variables set:
`yadm enter`
- Exit the sub-shell:
`exit`

26
tldr/yadm-git-crypt Executable file
View File

@@ -0,0 +1,26 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm git-crypt
> Git Crypt enables transparent encryption and decryption of files in a git repository.
> See also: `git-crypt`.
> More information: <https://github.com/AGWA/git-crypt>.
- Initialize repo to use Git Crypt:
`yadm git-crypt init`
- Share the repository using GPG:
`yadm git-crypt add-gpg-user {{user_id}}`
- After cloning a repository with encrypted files, unlock them:
`yadm git-crypt unlock`
- Export a symmetric secret key:
`yadm git-crypt export-key {{path/to/key_file}}`

26
tldr/yadm-gitconfig Executable file
View File

@@ -0,0 +1,26 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-gitconfig
> Pass options to `git config`. Change the `.gitconfig` of the repository managed by `yadm`.
> See also: `git config`.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>.
- Update or set a Git configuration value:
`yadm gitconfig {{key.inner-key}} {{value}}`
- Get a value from `yadm`'s Git configuration:
`yadm gitconfig --get {{key}}`
- Unset a value in `yadm`'s Git configuration:
`yadm gitconfig --unset {{key}}`
- List all values in `yadm`'s Git configuration:
`yadm gitconfig --list`

22
tldr/yadm-init Executable file
View File

@@ -0,0 +1,22 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-init
> Initialize a new, empty repository for tracking dotfiles.
> The repository is stored in `$HOME/.local/share/yadm/repo.git`.
> More information: <https://yadm.io/docs/getting_started>.
- Execute:
`yadm init`
- Override the worktree:
`yadm init -w {{path/to/worktree_folder}}`
- Overwrite an existing repository:
`yadm init -f {{path/to/local_repository}}`

26
tldr/yadm-introsepct Executable file
View File

@@ -0,0 +1,26 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-introspect
> Look at data that is managed by `yadm`.
> The purpose of introspection is to support command line completion.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>.
- Output commands:
`yadm introspect commands`
- Output configs:
`yadm introspect configs`
- Output switches for the main `yadm` command:
`yadm introspect switches`
- Output repo:
`yadm introspect repo`

17
tldr/yadm-list Executable file
View File

@@ -0,0 +1,17 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-list
> Print a list of files managed by `yadm`.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>.
- Print a list of files managed by `yadm` in the current directory:
`yadm list`
- List all files managed by `yadm` completely:
`yadm list -a`

14
tldr/yadm-perms Executable file
View File

@@ -0,0 +1,14 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-perms
> Update permissions.
> It is usually unnecessary to run this command, as `yadm` automatically processes permissions by default. This automatic behavior can be disabled by setting the configuration `yadm.auto-perms` to `"false"`.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#permissions>.
- Change file permissions:
`yadm perms`

31
tldr/yadm-transcrypt Executable file
View File

@@ -0,0 +1,31 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-transcrypt
> If `transcrypt` is installed, this command allows you to pass options directly to `transcrypt`.
> With the environment configured to use the yadm repository.
> Transcrypt enables transparent encryption and decryption of files in a Git repository.
> More information: <https://github.com/elasticdog/transcrypt>.
- Set the symmetric cipher to utilize for encryption:
`yadm transcrypt --cipher={{cipher}}`
- Pass the password to derive the key from:
`yadm transcrypt --password={{password}}`
- Assume yes and accept defaults for non-specified options:
`yadm transcrypt --yes`
- Display the current repository's cipher and password:
`yadm transcrypt --display`
- Re -encrypt all encrypted files using new credentials:
`yadm transcrypt --rekey`

18
tldr/yadm-upgrade Executable file
View File

@@ -0,0 +1,18 @@
---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# yadm-upgrade
> Upgrade `yadm` to the latest version.
> Upgrading will attempt to de-initialize and re-initialize your submodules.
> More information: <https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md#commands>.
- Upgrade `yadm` to the latest version:
`yadm upgrade`
- Force the upgrade regardless of changes:
`yadm upgrade -f`