diff --git a/tldr/apkeep b/tldr/apkeep index 791ae943..8e2cc30c 100644 --- a/tldr/apkeep +++ b/tldr/apkeep @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # apkeep > Download APK files from various sources. -> More information: . +> More information: . - Download an APK file to the specified directory: -`apkeep --app {{com.example.application}} {{path/to/directory}}` +`apkeep {{[-a|--app]}} {{com.example.application}} {{path/to/directory}}` - List all available versions for download: -`apkeep --app {{com.example.application}} --list-versions {{path/to/directory}}` +`apkeep {{[-a|--app]}} {{com.example.application}} {{[-l|--list-versions]}} {{path/to/directory}}` - Specify a store to download from: -`apkeep --app {{com.example.application}} --download-source {{apk-pure|google-play|f-droid|huawei-app-gallery}} {{path/to/directory}}` +`apkeep {{[-a|--app]}} {{com.example.application}} {{[-d|--download-source]}} {{apk-pure|google-play|f-droid|huawei-app-gallery}} {{path/to/directory}}` diff --git a/tldr/browsh b/tldr/browsh index b53d10e0..a6db0da1 100644 --- a/tldr/browsh +++ b/tldr/browsh @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # browsh > View webpages on the terminal using a Firefox backend. +> See also: `carbonyl`. > More information: . - Start browsh: diff --git a/tldr/bun-c b/tldr/bun-c new file mode 100644 index 00000000..b1f686ca --- /dev/null +++ b/tldr/bun-c @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun c + +> This command is an alias of `bun create`. + +- View documentation for the original command: + +`tldr bun create` diff --git a/tldr/bun-create b/tldr/bun-create new file mode 100644 index 00000000..ce9305c2 --- /dev/null +++ b/tldr/bun-create @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun create + +> Create a new project from a template. +> Note: `c` can be used as an alias for `create`. +> More information: . + +- Create a new project from an official template interactively: + +`bun create {{template}}` + +- Create a new project from an official template in a new directory: + +`bun create {{template}} {{path/to/destination}}` + +- Create a new project from a GitHub repository template: + +`bun create {{https://github.com/username/repo}} {{path/to/destination}}` + +- Create a new project from a local template: + +`bun create {{./path/to/template}} {{path/to/destination}}` + +- Create a new project, overwriting the destination directory if it exists: + +`bun create {{template}} {{path/to/destination} --force` + +- Create a new project without initializing a Git repository automatically: + +`bun create {{template}} {{path/to/destination} --no-git` + +- Create a new project without installing dependencies automatically: + +`bun create {{template}} {{path/to/destination} --no-install` diff --git a/tldr/carbonyl b/tldr/carbonyl index 98fad56a..bb6a3e83 100644 --- a/tldr/carbonyl +++ b/tldr/carbonyl @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # carbonyl > View webpages on the terminal using a Chromium backend. +> See also: `browsh`. > More information: . - Open an `about:blank` page: diff --git a/tldr/ffmpeg b/tldr/ffmpeg index 8138ae7e..c30b7ba2 100644 --- a/tldr/ffmpeg +++ b/tldr/ffmpeg @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ffmpeg > Video conversion tool. +> See also: `gst-launch-1.0`. > More information: . - Extract the sound from a video and save it as MP3: diff --git a/tldr/file b/tldr/file index 561488f3..efb6aef7 100644 --- a/tldr/file +++ b/tldr/file @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # file > Determine file type. +> See also: `stat`. > More information: . - Give a description of the type of the specified file: diff --git a/tldr/gst-launch-1.0 b/tldr/gst-launch-1.0 index 4f0e8ea4..2fe94383 100644 --- a/tldr/gst-launch-1.0 +++ b/tldr/gst-launch-1.0 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gst-launch-1.0 > Build and run a GStreamer pipeline. -> See also: `gst-inspect-1.0`. +> See also: `gst-inspect-1.0`, `ffmpeg`. > More information: . - Play test video in a window: diff --git a/tldr/jenkins b/tldr/jenkins new file mode 100644 index 00000000..10575e5f --- /dev/null +++ b/tldr/jenkins @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jenkins-cli + +> An open-source automation server that facilitates the automation of software development lifecycle. +> More information: . + +- Connect to jenkins CLI: + +`java -jar jenkins-cli.jar -s {{jenkins_server_url}} -auth {{username}}:{{api_token}}` + +- Restart jenkins: + +`java -jar jenkins-cli.jar -s {{jenkins_server_url}} restart` + +- Shutdown jenkins: + +`java -jar jenkins-cli.jar -s {{jenkins_server_url}} shutdown` + +- Display help: + +`java -jar jenkins-cli.jar -s {{jenkins_server_url}} help` + +- Display version: + +`java -jar jenkins-cli.jar -s {{jenkins_server_url}} version` diff --git a/tldr/linux/cage b/tldr/linux/cage index 4f90cff0..15b8f278 100644 --- a/tldr/linux/cage +++ b/tldr/linux/cage @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cage > Open an applications in a kiosk mode. +> See also: `gamescope`. > More information: . - Run an application: diff --git a/tldr/linux/gamescope b/tldr/linux/gamescope index 2e5ea19f..f0bff8fe 100644 --- a/tldr/linux/gamescope +++ b/tldr/linux/gamescope @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gamescope > A micro-compositor used as a game layer. +> See also: `cage`. > More information: . - Run a program with gamescope on the terminal: diff --git a/tldr/linux/guake b/tldr/linux/guake index e6bf87ab..4f54f4d3 100644 --- a/tldr/linux/guake +++ b/tldr/linux/guake @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # guake > A drop-down terminal for GNOME. +> See also: `yakuake`. > More information: . - Toggle Guake visibility: diff --git a/tldr/linux/hwinfo b/tldr/linux/hwinfo index 63e06c62..57ab492c 100644 --- a/tldr/linux/hwinfo +++ b/tldr/linux/hwinfo @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hwinfo > Probe for the hardware present in the system. +> See also: `inxi`, `lshw`. > More information: . - Display all available hardware information: diff --git a/tldr/linux/inxi b/tldr/linux/inxi index 45d34d8d..bbfb0151 100644 --- a/tldr/linux/inxi +++ b/tldr/linux/inxi @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # inxi > Print a summary of system information and resources for debugging purposes. +> See also: `lshw`, `hwinfo`. > More information: . - Print a summary of CPU, memory, hard drive and kernel information: diff --git a/tldr/linux/ip-route b/tldr/linux/ip-route index f0ebe574..1c2e679c 100644 --- a/tldr/linux/ip-route +++ b/tldr/linux/ip-route @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ip route > IP Routing table management subcommand. +> See also: `routel`. > More information: . - Display the `main` routing table: diff --git a/tldr/linux/lshw b/tldr/linux/lshw index dc5cf578..ec7ec50d 100644 --- a/tldr/linux/lshw +++ b/tldr/linux/lshw @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lshw > List detailed information about hardware configurations as root user. +> See also: `inxi`, `hwinfo`. > More information: . - Launch the X11 GUI (if available): diff --git a/tldr/linux/yakuake b/tldr/linux/yakuake index e243e50b..d4d214a3 100644 --- a/tldr/linux/yakuake +++ b/tldr/linux/yakuake @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # yakuake > A drop-down terminal for KDE. +> See also: `guake`. > More information: . - Start up Yakuake: diff --git a/tldr/npm-install-test b/tldr/npm-install-test new file mode 100644 index 00000000..a8e8344d --- /dev/null +++ b/tldr/npm-install-test @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm install-test + +> Equivalent to running `npm install` followed by `npm test`. +> Note: `it` can be used as shorthand for `install-test`. +> More information: . + +- Install all dependencies and then run tests: + +`npm install-test` + +- Install a specific package and then run tests: + +`npm install-test {{package_name}}` + +- Install a package and save it as a dependency before running tests: + +`npm install-test {{package_name}} {{[-S|--save]}}` + +- Install dependencies globally and then run tests: + +`npm install-test {{[-g|--global]}}` diff --git a/tldr/npm-it b/tldr/npm-it new file mode 100644 index 00000000..bee5426d --- /dev/null +++ b/tldr/npm-it @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm it + +> This command is an alias of `npm install-test`. + +- View documentation for the original command: + +`tldr npm install-test` diff --git a/tldr/osx/head b/tldr/osx/head index 104dc583..a1d8dd12 100644 --- a/tldr/osx/head +++ b/tldr/osx/head @@ -16,10 +16,10 @@ source: https://github.com/tldr-pages/tldr.git `head {{[-5|--lines 5]}} {{path/to/file1 path/to/file2 ...}}` -- Output the first `count` lines of a file: +- Output the first `n` lines of a file: -`head {{[-n|--lines]}} {{count}} {{path/to/file}}` +`head {{[-n|--lines]}} {{n}} {{path/to/file}}` -- Output the first n `bytes` of a file: +- Output the first `n` bytes of a file: -`head {{[-c|--bytes]}} {{bytes}} {{path/to/file}}` +`head {{[-c|--bytes]}} {{n}} {{path/to/file}}` diff --git a/tldr/pandoc b/tldr/pandoc index 38f5d2b5..5cae06ca 100644 --- a/tldr/pandoc +++ b/tldr/pandoc @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `pandoc {{path/to/input.md}} {{[-o|--output]}} {{path/to/output.pdf}}` -- Convert a Markdown file to PDF using the specified PDF engine: +- Convert the output from another command to PDF, using a specific PDF engine: -`pandoc {{path/to/input.md}} --pdf-engine {{tectonic|weasyprint|typst|...}} {{[-o|--output]}} {{path/to/output.pdf}}` +`{{command}} | pandoc {{[-f|--from]}} {{input_format}} --pdf-engine {{tectonic|weasyprint|typst|...}} {{[-o|--output]}} {{path/to/output.pdf}}` - Convert to a standalone file with the appropriate headers/footers (for LaTeX, HTML, etc.): @@ -28,6 +28,10 @@ source: https://github.com/tldr-pages/tldr.git `pandoc {{path/to/input}} {{[-L|--lua-filter]}} {{path/to/filter.lua}} {{[-o|--output]}} {{path/to/output}}` +- Convert a remote HTML file to markdown and print the result to `stdout`: + +`pandoc {{[-f|--from]}} html {{[-t|--to]}} markdown {{https://example.com}}` + - List all supported input formats: `pandoc --list-input-formats` diff --git a/tldr/poetry-init b/tldr/poetry-init new file mode 100644 index 00000000..2962eed4 --- /dev/null +++ b/tldr/poetry-init @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry init + +> Create a basic `pyproject.toml` file interactively. +> More information: . + +- Create a `pyproject.toml` file interactively: + +`poetry init` + +- Create a `pyproject.toml` file with prefilled values: + +`poetry init --name {{package_name}} --author "{{author_name }}"` + +- Create a `pyproject.toml` file without interaction (using defaults): + +`poetry init {{[-n|--no-interaction]}}` + +- Create a `pyproject.toml` file and add a dependency: + +`poetry init --dependency {{package_name}}` + +- Create a `pyproject.toml` file and add a development dependency: + +`poetry init --dev-dependency {{package_name}}` + +- Display help: + +`poetry init {{[-h|--help]}}` diff --git a/tldr/stat b/tldr/stat index ce1472a4..0b32e052 100644 --- a/tldr/stat +++ b/tldr/stat @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # stat > Display file and filesystem information. +> See also: `file`. > More information: . - Display properties about a specific file such as size, permissions, creation and access dates among others: