diff --git a/tldr/bd b/tldr/bd new file mode 100644 index 00000000..108d9e81 --- /dev/null +++ b/tldr/bd @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bd + +> A lightweight memory system and git-backed issue tracker for AI coding agents. +> More information: . + +- Initialize a project database: + +`bd init` + +- Create a new issue with description, priority, and type: + +`bd create {{issue_title}} {{[-d|--description]}} {{description}} {{[-p|--priority]}} {{1}} {{[-t|--type]}} {{bug|feature|task|epic|chore}}` + +- List all issues: + +`bd list` + +- Show issues ready to work on (no blockers): + +`bd ready` + +- Display details of a specific issue: + +`bd show {{issue_id}}` + +- Update an issue status: + +`bd update {{issue_id}} {{[-s|--status]}} {{open|in_progress|blocked|closed}}` + +- Manually sync changes and import latest from git: + +`bd sync` + +- Display help: + +`bd {{[-h|--help]}}` diff --git a/tldr/bun-init b/tldr/bun-init new file mode 100644 index 00000000..a4f8b334 --- /dev/null +++ b/tldr/bun-init @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun init + +> Scaffold an empty Bun project. +> More information: . + +- Initialize a Bun project in the current directory: + +`bun init` + +- Initialize in a specific directory: + +`bun init {{path/to/directory}}` + +- Initialize with a specific project name: + +`bun init {{[-n|--name]}} {{project_name}}` + +- Initialize a project with default prompts: + +`bun init {{[-y|--yes]}}` + +- Initialize a minimal project: + +`bun init {{[-m|--minimal]}}` + +- Initialize a React project: + +`bun init {{[-r|--react]}}` + +- Initialize a React project with Tailwind CSS: + +`bun init --react=tailwind` diff --git a/tldr/chainctl b/tldr/chainctl index 83674c8a..139fffcf 100644 --- a/tldr/chainctl +++ b/tldr/chainctl @@ -32,7 +32,7 @@ source: https://github.com/tldr-pages/tldr.git `chainctl images history {{image}}:{{tag}}` -- List package version data from repositories available to your account (e.g., package_name=go): +- List package version data from repositories available to your account (e.g., package_name=go): `chainctl packages versions list {{package_name}}` diff --git a/tldr/ippfind b/tldr/ippfind index 30d7bf76..b83bfb73 100644 --- a/tldr/ippfind +++ b/tldr/ippfind @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Send a PostScript test document to every PostScript printer on the network, whose name matches a `regex`: -`ippfind --txt-pdl application/postscript {{[-h|--host]}} {{regex}} {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-h|--host]}} {{regex}} {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` diff --git a/tldr/jira b/tldr/jira index 8c473231..d26da533 100644 --- a/tldr/jira +++ b/tldr/jira @@ -6,16 +6,29 @@ source: https://github.com/tldr-pages/tldr.git # jira > Interface (third party) for interacting with Jira. -> More information: . +> Note: Obtaining a Jira API token and exporting it to the shell as a `$JIRA_API_TOKEN` variable is required. +> More information: . + +- Create a configuration file (required before using `jira`): + +`jira init` - List recent issues: -`jira issue list` +`jira issue {{[ls|list]}}` + +- List unassigned issues with high priority: + +`jira issue {{[ls|list]}} {{[-a|--assignee]}} x {{[-y|--priority]}} High` - List issues from the current sprint, assigned to me: -`jira sprint list --current {{[-a|--assignee]}} $(jira me)` +`jira sprint {{[ls|list]}} --current {{[-a|--assignee]}} $(jira me)` -- Create a new issue, optionally set a parent issue: +- Create a new issue with a parent issue: `jira issue create {{[-P|--parent]}} {{parent}}` + +- Open an issue in the browser: + +`jira open {{123}}` diff --git a/tldr/kaggle-kernels b/tldr/kaggle-kernels new file mode 100644 index 00000000..2111241c --- /dev/null +++ b/tldr/kaggle-kernels @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kaggle kernels + +> Manage Kaggle kernels. +> More information: . + +- List all kernels: + +`kaggle {{[k|kernels]}} list` + +- List kernel output files: + +`kaggle {{[k|kernels]}} files {{kernel_name}}` + +- Initialize metadata file for a kernel (defaults to current directory): + +`kaggle {{[k|kernels]}} init {{[-p|--path]}} {{path/to/directory}}` + +- Push new code to a kernel and run the kernel: + +`kaggle {{[k|kernels]}} push {{[-p|--path]}} {{path/to/directory}}` + +- Pull a kernel: + +`kaggle {{[k|kernels]}} pull {{kernel_name}} {{[-p|--path]}} {{path/to/directory}}` + +- Get data output from the latest kernel run: + +`kaggle {{[k|kernels]}} output {{kernel_name}}` + +- Display the status of the latest kernel run: + +`kaggle {{[k|kernels]}} status {{kernel_name}}` diff --git a/tldr/linux/fuser b/tldr/linux/fuser index 147b30aa..39592d00 100644 --- a/tldr/linux/fuser +++ b/tldr/linux/fuser @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Identify processes using a TCP socket: -`fuser {{[-n|--namespace]}} tcp {{port}}` +`fuser {{port}}/tcp` - Kill all processes accessing a file or directory (sends the `SIGKILL` signal): diff --git a/tldr/linux/lrunzip b/tldr/linux/lrunzip index 5cf329c9..54cfe7b5 100644 --- a/tldr/linux/lrunzip +++ b/tldr/linux/lrunzip @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # lrunzip -> This command is an alias of `lrzip -d`. +> This command is an alias of `lrzip --decompress`. - View documentation for the original command: diff --git a/tldr/linux/lrzip b/tldr/linux/lrzip index 9361b168..bfab0379 100644 --- a/tldr/linux/lrzip +++ b/tldr/linux/lrzip @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Compress a file with BZIP2 - good middle ground for compression/speed: -`lrzip -b {{path/to/file}}` +`lrzip {{[-b|--bzip2]}} {{path/to/file}}` - Compress with ZPAQ - extreme compression, but very slow: -`lrzip -z {{path/to/file}}` +`lrzip {{[-z|--zpaq]}} {{path/to/file}}` - Compress with LZO - light compression, extremely fast decompression: -`lrzip -l {{path/to/file}}` +`lrzip {{[-l|--lzo]}} {{path/to/file}}` - Compress a file and password protect/encrypt it: -`lrzip -e {{path/to/file}}` +`lrzip {{[-e|--encrypt]}} {{path/to/file}}` - Override the number of processor threads to use: -`lrzip -p {{8}} {{path/to/file}}` +`lrzip {{[-p|--threads]}} {{8}} {{path/to/file}}` diff --git a/tldr/linux/lrztar b/tldr/linux/lrztar index a042da4e..363b66eb 100644 --- a/tldr/linux/lrztar +++ b/tldr/linux/lrztar @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Same as above, with ZPAQ - extreme compression, but very slow: -`lrztar -z {{path/to/directory}}` +`lrztar {{[-z|--zpaq]}} {{path/to/directory}}` - Specify the output file: -`lrztar -o {{path/to/file}} {{path/to/directory}}` +`lrztar {{[-o|--outfile]}} {{path/to/file}} {{path/to/directory}}` - Override the number of processor threads to use: -`lrztar -p {{8}} {{path/to/directory}}` +`lrztar {{[-p|--threads]}} {{8}} {{path/to/directory}}` - Force overwriting of existing files: -`lrztar -f {{path/to/directory}}` +`lrztar {{[-f|--force]}} {{path/to/directory}}` diff --git a/tldr/linux/lrzuntar b/tldr/linux/lrzuntar index f2a0f61f..10e36fca 100644 --- a/tldr/linux/lrzuntar +++ b/tldr/linux/lrzuntar @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # lrzuntar -> This command is an alias of `lrztar -d`. +> This command is an alias of `lrztar --decompress`. - View documentation for the original command: diff --git a/tldr/linux/toolbox b/tldr/linux/toolbox index 5bdcdb5d..aa840143 100644 --- a/tldr/linux/toolbox +++ b/tldr/linux/toolbox @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Some subcommands such as `create` have their own usage documentation. > More information: . -- Enter a container to use it interactively: +- Enter a Toolbx container to use it interactively: `toolbox enter {{container}}` @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `toolbox rmi {{image1 image2 ...}}` -- Display help for a specific subcommand (such as `create`, `enter`, `rm`, `rmi`, etc.): +- Display help for a specific subcommand (such as `create`, `enter`, `rm`, etc.): `toolbox help {{subcommand}}` diff --git a/tldr/linux/toolbox-create b/tldr/linux/toolbox-create index eabaedb2..f9720a3c 100644 --- a/tldr/linux/toolbox-create +++ b/tldr/linux/toolbox-create @@ -5,25 +5,25 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox create -> Create a new `toolbox` container. +> Create a new Toolbx container. > More information: . -- Create a `toolbox` container for a specific distribution: +- Create a Toolbx container for a specific distribution: `toolbox create {{[-d|--distro]}} {{distribution}}` -- Create a `toolbox` container for a specific release of the current distribution: +- Create a Toolbx container for a specific release of the current distribution: `toolbox create {{[-r|--release]}} {{release}}` -- Create a `toolbox` container with a custom image: +- Create a Toolbx container with a custom image: `toolbox create {{[-i|--image]}} {{name}}` -- Create a `toolbox` container from a custom Fedora image: +- Create a Toolbx container from a custom Fedora image: `toolbox create {{[-i|--image]}} {{quay.io/fedora/fedora:tag}}` -- Create a `toolbox` container using the default image for a specific Fedora release: +- Create a Toolbx container using the default image for a specific Fedora release: `toolbox create {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} f{{version}}` diff --git a/tldr/linux/toolbox-enter b/tldr/linux/toolbox-enter index 93b4ca3d..22946ca2 100644 --- a/tldr/linux/toolbox-enter +++ b/tldr/linux/toolbox-enter @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox enter -> Enter a `toolbox` container for interactive use. +> Enter a Toolbx container for interactive use. > See also: `toolbox run`. > More information: . -- Enter a `toolbox` container using the default image of a specific distribution: +- Enter a Toolbx container using the default image of a specific distribution: `toolbox enter {{[-d|--distro]}} {{distribution}}` -- Enter a `toolbox` container using the default image of a specific release of the current distribution: +- Enter a Toolbx container using the default image of a specific release of the current distribution: `toolbox enter {{[-r|--release]}} {{release}}` -- Enter a toolbox container using the default image for a specific Fedora release: +- Enter a Toolbx container using the default image for a specific Fedora release: `toolbox enter {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} f{{version}}` diff --git a/tldr/linux/toolbox-help b/tldr/linux/toolbox-help index d0d48ae9..3a7057d2 100644 --- a/tldr/linux/toolbox-help +++ b/tldr/linux/toolbox-help @@ -5,13 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox help -> Display help information about `toolbox`. +> Display help information about Toolbx. > More information: . -- Display the `toolbox` manual: +- Display the Toolbx manual: `toolbox help` -- Display the `toolbox` manual for a specific subcommand: +- Display the Toolbx manual for a specific subcommand: `toolbox help {{subcommand}}` diff --git a/tldr/linux/toolbox-init-container b/tldr/linux/toolbox-init-container index 32307c26..4c061e40 100644 --- a/tldr/linux/toolbox-init-container +++ b/tldr/linux/toolbox-init-container @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox init-container -> Initialize a running `toolbox` container. +> Initialize a running Toolbx container. > This command should not be executed by the user, and cannot be run on the host. > More information: . -- Initialize a running toolbox: +- Initialize a running Toolbx container: `toolbox init-container --gid {{gid}} --home {{home}} --home-link --media-link --mnt-link --monitor-host --shell {{shell}} --uid {{uid}} --user {{user}}` diff --git a/tldr/linux/toolbox-list b/tldr/linux/toolbox-list index 79762d95..b5abda36 100644 --- a/tldr/linux/toolbox-list +++ b/tldr/linux/toolbox-list @@ -5,17 +5,17 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox list -> List existing `toolbox` containers and images. +> List existing Toolbx containers and images. > More information: . -- List all `toolbox` containers and images: +- List all Toolbx containers and images: `toolbox list` -- List only `toolbox` containers: +- List only Toolbx containers: `toolbox list {{[-c|--containers]}}` -- List only `toolbox` images: +- List only Toolbx images: `toolbox list {{[-i|--images]}}` diff --git a/tldr/linux/toolbox-rm b/tldr/linux/toolbox-rm index a62415fc..77108f72 100644 --- a/tldr/linux/toolbox-rm +++ b/tldr/linux/toolbox-rm @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox rm -> Remove one or more `toolbox` containers. +> Remove one or more Toolbx containers. > See also: `toolbox rmi`. > More information: . -- Remove a toolbox container: +- Remove a Toolbx container: `toolbox rm {{container_name}}` -- Remove all `toolbox` containers: +- Remove all Toolbx containers: `toolbox rm {{[-a|--all]}}` -- Force the removal of a currently active `toolbox` container: +- Force the removal of a currently active Toolbx container: `toolbox rm {{[-f|--force]}} {{container_name}}` diff --git a/tldr/linux/toolbox-rmi b/tldr/linux/toolbox-rmi index 37d7b8c2..b059e1fa 100644 --- a/tldr/linux/toolbox-rmi +++ b/tldr/linux/toolbox-rmi @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox rmi -> Remove `toolbox` images. +> Remove Toolbx images. > See also: `toolbox rm`. > More information: . -- Remove one or more `toolbox` image: +- Remove one or more Toolbx image: `toolbox rmi {{image_name1 image_name2 ...}}` -- Remove all `toolbox` images: +- Remove all Toolbx images: `toolbox rmi {{[-a|--all]}}` -- Force the removal of a `toolbox` image which is currently being used by a container (the container will be removed as well): +- Force the removal of a Toolbx image which is currently being used by a container (the container will be removed as well): `toolbox rmi {{[-f|--force]}} {{image_name}}` diff --git a/tldr/linux/toolbox-run b/tldr/linux/toolbox-run index 7821faa1..6367e1fb 100644 --- a/tldr/linux/toolbox-run +++ b/tldr/linux/toolbox-run @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # toolbox run -> Run a command in an existing `toolbox` container. +> Run a command in an existing Toolbx container. > See also: `toolbox enter`. > More information: . -- Run a command inside a specific `toolbox` container: +- Run a command inside a specific Toolbx container: `toolbox run {{[-c|--container]}} {{container_name}} {{command}}` -- Run a command inside a `toolbox` container for a specific release of a distribution: +- Run a command inside a Toolbx container for a specific release of a distribution: `toolbox run {{[-d|--distro]}} {{distribution}} {{[-r|--release]}} {{release}} {{command}}` -- Run `emacs` inside a `toolbox` container using the default image for a specific Fedora release: +- Run `emacs` inside a Toolbx container using the default image for a specific Fedora release: `toolbox run {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} f{{version}} {{emacs}}` diff --git a/tldr/lzcat b/tldr/lzcat index dfe43912..536aaab8 100644 --- a/tldr/lzcat +++ b/tldr/lzcat @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # lzcat -> This command is an alias of `xz --format=lzma --decompress --stdout`. +> This command is an alias of `xz --format lzma --decompress --stdout`. - View documentation for the original command: diff --git a/tldr/lzma b/tldr/lzma index 3c84c276..2ee09681 100644 --- a/tldr/lzma +++ b/tldr/lzma @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # lzma -> This command is an alias of `xz --format=lzma`. +> This command is an alias of `xz --format lzma`. - View documentation for the original command: diff --git a/tldr/piodebuggdb b/tldr/piodebuggdb index 6e3b4fa0..cebc79a9 100644 --- a/tldr/piodebuggdb +++ b/tldr/piodebuggdb @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # piodebuggdb -> This command is an alias of `pio debug --interface=gdb`. +> This command is an alias of `pio debug --interface gdb`. - View documentation for the original command: diff --git a/tldr/podman b/tldr/podman index 51b0532d..11350ced 100644 --- a/tldr/podman +++ b/tldr/podman @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List all containers (both running and stopped): -`podman ps --all` +`podman ps {{[-a|--all]}}` - Create a container from an image, with a custom name: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Open a shell inside an already running container: -`podman exec --interactive --tty {{container_name}} {{sh}}` +`podman exec {{[-it|--interactive --tty]}} {{container_name}} {{sh}}` - Remove a stopped container: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the logs of one or more containers and follow log output: -`podman logs --follow {{container_name}} {{container_id}}` +`podman logs {{[-f|--follow]}} {{container_name}} {{container_id}}` diff --git a/tldr/podman-build b/tldr/podman-build index 9834e913..7808d82e 100644 --- a/tldr/podman-build +++ b/tldr/podman-build @@ -6,7 +6,6 @@ source: https://github.com/tldr-pages/tldr.git # podman build > Daemonless tool for building container images. -> Podman provides a Docker-CLI comparable command-line. Simply put: `alias docker=podman`. > More information: . - Create an image using a `Dockerfile` or `Containerfile` in the specified directory: @@ -15,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Create an image with a specified tag: -`podman build --tag {{image_name:version}} {{path/to/directory}}` +`podman build {{[-t|--tag]}} {{image_name:version}} {{path/to/directory}}` - Create an image from a non-standard file: -`podman build --file {{Containerfile.different}} .` +`podman build {{[-f|--file]}} {{Containerfile.different}} .` - Create an image without using any previously cached images: @@ -27,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Create an image suppressing all output: -`podman build --quiet {{path/to/directory}}` +`podman build {{[-q|--quiet]}} {{path/to/directory}}` diff --git a/tldr/podman-image b/tldr/podman-image index 338e316d..4f14e40c 100644 --- a/tldr/podman-image +++ b/tldr/podman-image @@ -5,22 +5,22 @@ source: https://github.com/tldr-pages/tldr.git --- # podman image -> Manage Docker images. +> Manage OCI/Docker container images. > See also: `podman build`, `podman import`, `podman pull`. > More information: . -- List local Docker images: +- List local container images: -`podman image ls` +`podman image {{[ls|list]}}` -- Delete unused local Docker images: +- Delete unused local container images: `podman image prune` - Delete all unused images (not just those without a tag): -`podman image prune --all` +`podman image prune {{[-a|--all]}}` -- Show the history of a local Docker image: +- Show the history of a local container image: `podman image history {{image}}` diff --git a/tldr/podman-images b/tldr/podman-images index a2f20262..e2c9a077 100644 --- a/tldr/podman-images +++ b/tldr/podman-images @@ -5,24 +5,24 @@ source: https://github.com/tldr-pages/tldr.git --- # podman images -> Manage Podman images. +> Manage OCI/Docker container images. > More information: . -- List all Podman images: +- List all container images: `podman images` -- List all Podman images including intermediates: +- List all container images including intermediates: -`podman images --all` +`podman images {{[-a|--all]}}` - List the output in quiet mode (only numeric IDs): -`podman images --quiet` +`podman images {{[-q|--quiet]}}` -- List all Podman images not used by any container: +- List all images not used by any container: -`podman images --filter dangling=true` +`podman images {{[-f|--filter]}} dangling=true` - List images that contain a substring in their name: diff --git a/tldr/podman-login b/tldr/podman-login index be8998b2..ee6fba95 100644 --- a/tldr/podman-login +++ b/tldr/podman-login @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Log in to an insecure (HTTP) registry: -`podman login --tls-verify=false {{registry.example.org}}` +`podman login --tls-verify false {{registry.example.org}}` diff --git a/tldr/podman-machine b/tldr/podman-machine index 2372f77a..dd03ed01 100644 --- a/tldr/podman-machine +++ b/tldr/podman-machine @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List existing machines: -`podman machine ls` +`podman machine {{[ls|list]}}` - Create a new default machine: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a new machine with different resources: -`podman machine init --cpus={{4}} --memory={{4096}} --disk-size={{50}}` +`podman machine init --cpus {{4}} --memory {{4096}} --disk-size {{50}}` - Start or stop a machine: diff --git a/tldr/podman-ps b/tldr/podman-ps index 474bf14c..4975f65f 100644 --- a/tldr/podman-ps +++ b/tldr/podman-ps @@ -14,28 +14,28 @@ source: https://github.com/tldr-pages/tldr.git - List all Podman containers (running and stopped): -`podman ps --all` +`podman ps {{[-a|--all]}}` - Show the latest created container (includes all states): -`podman ps --latest` +`podman ps {{[-l|--latest]}}` - Filter containers that contain a substring in their name: -`podman ps --filter "name={{name}}"` +`podman ps {{[-f|--filter]}} "name={{name}}"` - Filter containers that share a given image as an ancestor: -`podman ps --filter "ancestor={{image}}:{{tag}}"` +`podman ps {{[-f|--filter]}} "ancestor={{image}}:{{tag}}"` - Filter containers by exit status code: -`podman ps --all --filter "exited={{code}}"` +`podman ps {{[-a|--all]}} {{[-f|--filter]}} "exited={{code}}"` - Filter containers by status (created, running, removing, paused, exited and dead): -`podman ps --filter "status={{status}}"` +`podman ps {{[-f|--filter]}} "status={{status}}"` - Filter containers that mount a specific volume or have a volume mounted in a specific path: -`podman ps --filter "volume={{path/to/directory}}" --format "table {{.ID}} {{.Image}} {{.Names}} {{.Mounts}}"` +`podman ps {{[-f|--filter]}} "volume={{path/to/directory}}" --format "table {{.ID}} {{.Image}} {{.Names}} {{.Mounts}}"` diff --git a/tldr/podman-rmi b/tldr/podman-rmi index 205e0810..43e95b6c 100644 --- a/tldr/podman-rmi +++ b/tldr/podman-rmi @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # podman rmi -> Remove Podman images. +> Remove OCI/Docker images. > More information: . - Remove one or more images given their names: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Force remove an image: -`podman rmi --force {{image}}` +`podman rmi {{[-f|--force]}} {{image}}` - Remove an image without deleting untagged parents: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`podman rmi` +`podman rmi {{[-h|--help]}}` diff --git a/tldr/podman-run b/tldr/podman-run index ced07a7a..63ae070c 100644 --- a/tldr/podman-run +++ b/tldr/podman-run @@ -14,23 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Run command in a new container in background and display its ID: -`podman run --detach {{image:tag}} {{command}}` +`podman run {{[-d|--detach]}} {{image:tag}} {{command}}` - Run command in a one-off container in interactive mode and pseudo-TTY: -`podman run --rm --interactive --tty {{image:tag}} {{command}}` +`podman run --rm {{[-it|--interactive --tty]}} {{image:tag}} {{command}}` - Run command in a new container with passed environment variables: -`podman run --env '{{variable}}={{value}}' --env {{variable}} {{image:tag}} {{command}}` +`podman run {{[-e|--env]}} '{{variable}}={{value}}' {{[-e|--env]}} {{variable}} {{image:tag}} {{command}}` - Run command in a new container with bind mounted volumes: -`podman run --volume /{{path/to/host_path}}:/{{path/to/container_path}} {{image:tag}} {{command}}` +`podman run {{[-v|--volume]}} /{{path/to/host_path}}:/{{path/to/container_path}} {{image:tag}} {{command}}` - Run command in a new container with published ports: -`podman run --publish {{host_port}}:{{container_port}} {{image:tag}} {{command}}` +`podman run {{[-p|--publish]}} {{host_port}}:{{container_port}} {{image:tag}} {{command}}` - Run command in a new container overwriting the entrypoint of the image: diff --git a/tldr/realpath b/tldr/realpath index 3def7ed0..638a6568 100644 --- a/tldr/realpath +++ b/tldr/realpath @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `realpath {{[-e|--canonicalize-existing]}} {{path/to/file_or_directory}}` -- Resolve ".." components before symlinks: +- Resolve `..` components before symlinks: `realpath {{[-L|--logical]}} {{path/to/file_or_directory}}` diff --git a/tldr/wrk b/tldr/wrk index 6c7afbc4..c80a8526 100644 --- a/tldr/wrk +++ b/tldr/wrk @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a benchmark with a custom header: -`wrk {{[-t|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} {{[-H|--header]}} "{{Host: example.com}}" "{{http://example.com/index.html}}"` +`wrk {{[-t|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} {{[-H|--header]}} "{{Host: example.com}}" "{{http://example.com/index.html}}"` - Run a benchmark with a request timeout of `2` seconds: diff --git a/tldr/yes b/tldr/yes index dab98423..2ae5cb8e 100644 --- a/tldr/yes +++ b/tldr/yes @@ -9,14 +9,14 @@ source: https://github.com/tldr-pages/tldr.git > This command is commonly used to answer yes to every prompt by install commands (such as `apt-get`). > More information: . -- Repeatedly output "message": - -`yes {{message}}` - -- Repeatedly output "y": +- Repeatedly output `y`: `yes` +- Repeatedly output a specified value: + +`yes {{value}}` + - Accept everything prompted by the `apt-get` command: `yes | sudo apt-get install {{program}}` diff --git a/tldr/zstd b/tldr/zstd index 00e4a88a..4eebf95a 100644 --- a/tldr/zstd +++ b/tldr/zstd @@ -24,6 +24,10 @@ source: https://github.com/tldr-pages/tldr.git `zstd -{{level}} {{path/to/file}}` +- Compress a file using an ultra-fast compression level, where 1=default: + +`zstd --fast={{level}} {{path/to/file}}` + - Unlock higher compression levels (up to 22) using more memory (both for compression and decompression): `zstd --ultra -{{level}} {{path/to/file}}`