diff --git a/tldr/bk b/tldr/bk new file mode 100644 index 00000000..0afae537 --- /dev/null +++ b/tldr/bk @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bk + +> Manage Buildkite builds, pipelines, and agents. +> More information: . + +- Configure the API token and organization: + +`bk configure` + +- Select an organization to use: + +`bk use {{organization_slug}}` + +- Initialize a `pipeline.yaml` file: + +`bk init` + +- List all pipelines in the current organization: + +`bk pipeline list` + +- Trigger a build for a pipeline: + +`bk build create {{pipeline_slug}}` + +- View the status of a specific build: + +`bk build view {{build_number}}` + +- List all agents in the current organization: + +`bk agent list` + +- Display help: + +`bk {{[-h|--help]}}` diff --git a/tldr/cdk b/tldr/cdk index 0848dbe4..0856dd82 100644 --- a/tldr/cdk +++ b/tldr/cdk @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # cdk -> A CLI for AWS Cloud Development Kit (CDK). +> AWS Cloud Development Kit. > More information: . - List the stacks in the app: diff --git a/tldr/dict b/tldr/dict index 26314eba..09d636af 100644 --- a/tldr/dict +++ b/tldr/dict @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # dict -> Command line dictionary using the DICT protocol. +> Dictionary that uses the DICT protocol. > More information: . - List available databases: diff --git a/tldr/hive b/tldr/hive index ae7fef28..f8e58bf2 100644 --- a/tldr/hive +++ b/tldr/hive @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # hive -> CLI tool for Apache Hive. +> Tool for Apache Hive. > More information: . - Start a Hive interactive shell: diff --git a/tldr/imgcat b/tldr/imgcat index 0b0b26d8..52ddbf1d 100644 --- a/tldr/imgcat +++ b/tldr/imgcat @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # imgcat -> Display images on the command-line. +> Display images. > Requires a compatible terminal such as iTerm2. > More information: . diff --git a/tldr/immich b/tldr/immich index a8d1a02e..e178be42 100644 --- a/tldr/immich +++ b/tldr/immich @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # immich -> Immich command-line interface (CLI) that allows you to perform certain actions. +> Manage Immich servers. > See also: `immich-go`. > More information: . @@ -19,16 +19,16 @@ source: https://github.com/tldr-pages/tldr.git - Upload a directory including subdirectories: -`immich upload --recursive {{path/to/directory}}` +`immich upload {{[-r|--recursive]}} {{path/to/directory}}` - Create an album based on a directory: -`immich upload --album-name "{{My summer holiday}}" --recursive {{path/to/directory}}` +`immich upload {{[-r|--recursive]}} {{path/to/directory}} {{[-A|--album-name]}} "{{My summer holiday}}"` - Skip assets matching a glob pattern: -`immich upload --ignore {{**/Raw/** **/*.tif}} --recursive {{path/to/directory}}` +`immich upload {{[-r|--recursive]}} {{path/to/directory}} {{[-i|--ignore]}} {{**/Raw/** **/*.tif}}` - Include hidden files: -`immich upload --include-hidden --recursive {{path/to/directory}}` +`immich upload {{[-r|--recursive]}} {{path/to/directory}} {{[-H|--include-hidden]}}` diff --git a/tldr/immich-go b/tldr/immich-go index 2c3c0710..62e18d19 100644 --- a/tldr/immich-go +++ b/tldr/immich-go @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # immich-go > Immich-Go is an open-source tool designed to streamline uploading large photo collections to your self-hosted Immich server. -> See also: `immich-cli`. +> See also: `immich`. > More information: . - Upload a Google Photos takeout file to Immich server: diff --git a/tldr/kaggle-competitions b/tldr/kaggle-competitions index cfac8735..e0897dd9 100644 --- a/tldr/kaggle-competitions +++ b/tldr/kaggle-competitions @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # kaggle competitions -> Manage Kaggle competitions from the command-line. +> Manage Kaggle competitions. > More information: . - List all competitions: diff --git a/tldr/kaggle-datasets b/tldr/kaggle-datasets index 00ef78a7..18fc5ade 100644 --- a/tldr/kaggle-datasets +++ b/tldr/kaggle-datasets @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # kaggle datasets -> Manage Kaggle datasets from command line. +> Manage Kaggle datasets. > More information: . - List all datasets owned by a user or organization: diff --git a/tldr/kubectl-cp b/tldr/kubectl-cp new file mode 100644 index 00000000..d1a7d886 --- /dev/null +++ b/tldr/kubectl-cp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl cp + +> Copy files and directories between a local filesystem and a container in a pod. +> More information: . + +- Copy a local file or directory to a pod: + +`kubectl cp {{path/to/local_file}} {{pod_name}}:/{{path/to/file_in_pod}}` + +- Copy a local file or directory to a pod in a specific namespace: + +`kubectl cp {{path/to/local_file}} {{namespace}}/{{pod_name}}:/{{path/to/file_in_pod}}` + +- Copy a file or directory from a pod to the local machine: + +`kubectl cp {{namespace}}/{{pod_name}}:/{{path/to/file_in_pod}} {{path/to/local_file}}` + +- Copy a file or directory to a specific container in a pod: + +`kubectl cp {{path/to/local_file}} {{pod_name}}:/{{path/to/file_in_pod}} {{[-c|--container]}} {{container_name}}` + +- Copy a file or directory to a pod without preserving ownership and permissions: + +`kubectl cp {{path/to/local_file}} {{namespace}}/{{pod_name}}:/{{path/to/file_in_pod}} --no-preserve` + +- Copy a local file or directory to a pod with retries on failure: + +`kubectl cp {{path/to/local_file}} {{pod_name}}:/{{path/to/file_in_pod}} --retries {{3}}` diff --git a/tldr/linux/calcurse b/tldr/linux/calcurse index 7363f543..18f39ff8 100644 --- a/tldr/linux/calcurse +++ b/tldr/linux/calcurse @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # calcurse -> A text-based calendar and scheduling application for the command-line. +> A text-based calendar and scheduling application. > More information: . - Start `calcurse` on interactive mode: diff --git a/tldr/linux/chat b/tldr/linux/chat index 33344388..e04e0ea9 100644 --- a/tldr/linux/chat +++ b/tldr/linux/chat @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Commonly used to establish PPP (Point-to-Point Protocol) connections. > More information: . -- Execute a chat script directly from the command line: +- Execute a chat script directly: `chat '{{expect_send_pairs}}'` diff --git a/tldr/linux/firewall-cmd b/tldr/linux/firewall-cmd index 81af8a09..e51966b2 100644 --- a/tldr/linux/firewall-cmd +++ b/tldr/linux/firewall-cmd @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # firewall-cmd -> The firewalld command-line client. +> The firewalld client. > View and adapt the runtime or permanent firewall configuration state. > More information: . diff --git a/tldr/linux/pamac b/tldr/linux/pamac index e9150e82..53b14887 100644 --- a/tldr/linux/pamac +++ b/tldr/linux/pamac @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pamac -> A command-line utility for the GUI package manager pamac. +> Utility for the GUI package manager pamac. > If you can't see the AUR packages, enable it in `/etc/pamac.conf` or in the GUI. > More information: . diff --git a/tldr/linux/pkgctl b/tldr/linux/pkgctl index a80de44d..7631251c 100644 --- a/tldr/linux/pkgctl +++ b/tldr/linux/pkgctl @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pkgctl -> Unified command-line frontend for Arch Linux devtools. +> Unified frontend for Arch Linux devtools. > More information: . - View documentation for authenticating `pkgctl` with services like GitLab: diff --git a/tldr/minipro b/tldr/minipro new file mode 100644 index 00000000..ae0490b7 --- /dev/null +++ b/tldr/minipro @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minipro + +> Control Xgecu chip programmers (TL866A/CS, TL866II+, T48, T56). +> Supports various chips including AVRs, PICs, microcontrollers, and memory chips. +> More information: . + +- List all supported devices: + +`minipro {{[-l|--list]}}` + +- Search for a specific device: + +`minipro {{[-L|--search]}} {{device_name}}` + +- Read chip ID: + +`minipro {{[-p|--device]}} {{chip_name}} {{[-D|--read_id]}}` + +- Read chip contents to a file: + +`minipro {{[-p|--device]}} {{chip_name}} {{[-r|--read]}} {{path/to/output_file.bin}}` + +- Write a file to chip: + +`minipro {{[-p|--device]}} {{chip_name}} {{[-w|--write]}} {{path/to/input_file.bin}}` + +- Verify chip contents against a file: + +`minipro {{[-p|--device]}} {{chip_name}} {{[-m|--verify]}} {{path/to/file.bin}}` + +- Erase a chip: + +`minipro {{[-p|--device]}} {{chip_name}} {{[-E|--erase]}}` + +- Display help: + +`minipro {{[-h|--help]}}` diff --git a/tldr/nh b/tldr/nh new file mode 100644 index 00000000..73ee4bdc --- /dev/null +++ b/tldr/nh @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nh + +> Modern helper utility tool for the Nix/Nixos ecosystem. +> More information: . + +- Search for a package in Nixpkgs, limiting results: + +`nh search {{[-l|--limit]}} {{number}} {{name}}` + +- Collect all garbage and gcroots from the Nix store: + +`nh clean all {{[-a|--ask]}}` + +- Build a specified Nixos flake configuration and open it in a virtual machine: + +`nh os build-vm {{path/to/flake}} {{[-H|--hostname]}} {{host}}` + +- Build and switch to a specified Home manager flake configuration: + +`nh home switch {{path/to/flake}} {{[-c|--configuration]}} {{home}}` + +- Build and switch to a nix-darwin flake configuration: + +`nh darwin switch {{path/to/flake}} {{[-H|--hostname]}} {{host}}` + +- Generate shell completions for a specified shell: + +`nh completions {{shell}}` diff --git a/tldr/scala b/tldr/scala index 7aa93ebc..d731c342 100644 --- a/tldr/scala +++ b/tldr/scala @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `scala {{filename.jar}}` -- Execute a single Scala command in the command-line: +- Execute a single Scala command: `scala {{[-e|--execute-script]}} {{command}}` diff --git a/tldr/timg b/tldr/timg new file mode 100644 index 00000000..acd1c1fa --- /dev/null +++ b/tldr/timg @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# timg + +> A terminal image and video viewer. +> More information: . + +- Display a static image: + +`timg {{image.jpg}}` + +- Display all JPEG images in the current directory: + +`timg *.jpg` + +- Display all the bitmaps in icons file: + +`timg {{example.ico}}` + +- Play a video: + +`timg {{video.mp4}}` + +- Play contents of webcam: + +`timg {{/dev/videoX}}` + +- Play an animated GIF: + +`timg {{gif.gif}}` + +- Display version: + +`timg --version` diff --git a/tldr/windows/octo b/tldr/windows/octo index a3c2188b..8aa4f180 100644 --- a/tldr/windows/octo +++ b/tldr/windows/octo @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # octo -> Command-line tools for Octopus Deploy. +> Tools for Octopus Deploy. > More information: . - Create a package: