diff --git a/tldr/az-network b/tldr/az-network index 160a819e..ad464e54 100644 --- a/tldr/az-network +++ b/tldr/az-network @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a virtual network: -`az network vnet create --address-prefixes {{10.0.0.0/16}} {{[-n|--name]}} {{vnet}} {{[-g|--resource-group]}} {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` +`az network vnet create --address-prefixes {{10.0.0.0/16}} {{[-n|--name]}} {{vnet}} {{[-g|--resource-group]}} {{group_name}} --subnet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` - Enable accelerated networking for a network interface card: diff --git a/tldr/gh-a11y b/tldr/gh-a11y new file mode 100644 index 00000000..bc5ce4f6 --- /dev/null +++ b/tldr/gh-a11y @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh a11y + +> This command is an alias of `gh accessibility`. + +- View documentation for the original command: + +`tldr gh accessibility` diff --git a/tldr/gh-accessibility b/tldr/gh-accessibility new file mode 100644 index 00000000..10dd27a2 --- /dev/null +++ b/tldr/gh-accessibility @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh accessibility + +> Learn about GitHub CLI's accessibility experiences. +> More information: . + +- Open the GitHub Accessibility site in your browser: + +`gh {{[a11y|accessibility]}} {{[-w|--web]}}` diff --git a/tldr/gh-pr-checks b/tldr/gh-pr-checks new file mode 100644 index 00000000..2d1d0c10 --- /dev/null +++ b/tldr/gh-pr-checks @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh pr checks + +> View CI checks for a GitHub pull request. +> More information: . + +- Show checks for the pull request of the current branch: + +`gh pr checks` + +- Show checks for a specific pull request: + +`gh pr checks {{pr_number}}` + +- Watch checks and update in real time until completion: + +`gh pr checks {{pr_number}} --watch` + +- Show only required checks: + +`gh pr checks {{pr_number}} --required` diff --git a/tldr/gh-pr-merge b/tldr/gh-pr-merge index 002ba046..53408450 100644 --- a/tldr/gh-pr-merge +++ b/tldr/gh-pr-merge @@ -5,33 +5,29 @@ source: https://github.com/tldr-pages/tldr.git --- # gh pr merge -> Merge GitHub pull requests. +> Merge a GitHub pull request. > More information: . - Merge the pull request associated with the current branch interactively: `gh pr merge` -- Merge the specified pull request, interactively: +- Merge the current branch into the specified pull request: -`gh pr merge {{pr_number}}` +`gh pr merge {{pr_number}} {{[-m|--merge]}}` -- Merge the pull request, removing the branch on both the local and the remote: +- Squash and merge a pull request, then delete the branch: -`gh pr merge {{[-d|--delete-branch]}}` +`gh pr merge {{pr_number}} {{[-sd|--squash --delete-branch]}}` -- Merge the current pull request with the specified merge strategy: +- Rebase and merge: -`gh pr merge --{{merge|squash|rebase}}` +`gh pr merge {{pr_number}} {{[-r|--rebase]}}` -- Merge the current pull request with the specified merge strategy and commit message: +- Enable auto-merge (squash): -`gh pr merge --{{merge|squash|rebase}} {{[-t|--subject]}} {{commit_message}}` +`gh pr merge {{pr_number}} --auto {{[-s|--squash]}}` -- Squash the current pull request into one commit with the message body and merge: +- Merge with admin privileges (if allowed): -`gh pr merge {{[-s|--squash]}} {{[-b|--body]}} "{{commit_message_body}}"` - -- Display help: - -`gh pr merge {{[-h|--help]}}` +`gh pr merge {{pr_number}} --admin` diff --git a/tldr/kdash b/tldr/kdash index 5eb96695..78b552bd 100644 --- a/tldr/kdash +++ b/tldr/kdash @@ -5,8 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # kdash -> A simple terminal dashboard for Kubernetes. -> Mode information: . +> A simple dashboard for Kubernetes. +> More information: . - Show dashboard: diff --git a/tldr/kubectl-debug b/tldr/kubectl-debug new file mode 100644 index 00000000..620257a7 --- /dev/null +++ b/tldr/kubectl-debug @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl debug + +> Debug cluster resources using interactive debugging containers. +> More information: . + +- Create an interactive debugging session in a pod and immediately attach to it: + +`kubectl debug {{pod_name}} {{[-it|--stdin --tty]}} --image busybox` + +- Create a debug container with a custom image and name: + +`kubectl debug --image {{image}} {{[-c|--container]}} {{container_name}} {{pod_name}}` + +- Create an interactive debugging session on a node and immediately attach to it (the container will run in the host namespaces and the host's filesystem will be mounted at `/host`): + +`kubectl debug node/{{node_name}} {{[-it|--stdin --tty]}} --image busybox` + +- Create a copy of a pod and add a debug container to it: + +`kubectl debug {{pod_name}} {{[-it|--stdin --tty]}} --image {{image}} --copy-to {{pod_copy_name}}` + +- Create a copy of a pod and change the command of a specific container: + +`kubectl debug {{pod_name}} {{[-it|--stdin --tty]}} --copy-to {{pod_copy_name}} --container {{container_name}} -- {{command}}` + +- Create a copy of a pod and change the image of a specific container: + +`kubectl debug {{pod_name}} --copy-to {{pod_copy_name}} --set-image {{container_name}}={{image}}` + +- Create a copy of a pod and change all container images: + +`kubectl debug {{pod_name}} --copy-to {{pod_copy_name}} --set-image '*={{image}}'` + +- Create an ephemeral debug container and target a specific container (useful for debugging distroless containers): + +`kubectl debug {{pod_name}} {{[-it|--stdin --tty]}} --image {{image}} --target {{target_container_name}}` diff --git a/tldr/linux/bootctl b/tldr/linux/bootctl index 833f076c..0368d4cd 100644 --- a/tldr/linux/bootctl +++ b/tldr/linux/bootctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bootctl > Control EFI firmware boot settings and manage boot loader. -> More information: . +> More information: . - Show information about the system firmware and the bootloaders: diff --git a/tldr/linux/homectl b/tldr/linux/homectl index e58b9252..9c1d6544 100644 --- a/tldr/linux/homectl +++ b/tldr/linux/homectl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # homectl > Create, remove, change or inspect home directories using the systemd-homed service. -> More information: . +> More information: . - List user accounts and their associated home directories: diff --git a/tldr/linux/hostnamectl b/tldr/linux/hostnamectl index ec2cd707..e5c005d8 100644 --- a/tldr/linux/hostnamectl +++ b/tldr/linux/hostnamectl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hostnamectl > Get or set the hostname of the computer. -> More information: . +> More information: . - Get the hostname of the computer: diff --git a/tldr/linux/importctl b/tldr/linux/importctl index 7d46fdbe..3ab7c680 100644 --- a/tldr/linux/importctl +++ b/tldr/linux/importctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # importctl > Download, Import, or Export disk images. -> More information: . +> More information: . - Download image in tarball format from a url via pull: diff --git a/tldr/linux/journalctl b/tldr/linux/journalctl index 5743e44a..4de6fbb0 100644 --- a/tldr/linux/journalctl +++ b/tldr/linux/journalctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # journalctl > Query the systemd journal. -> More information: . +> More information: . - Show all messages with priority level 3 (errors) from this boot: diff --git a/tldr/linux/kernel-install b/tldr/linux/kernel-install index 62658fdc..13753edc 100644 --- a/tldr/linux/kernel-install +++ b/tldr/linux/kernel-install @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kernel-install > Add and remove kernel and initrd images to and from `/boot`. -> More information: . +> More information: . - Add kernel and initramfs images to bootloader partition: diff --git a/tldr/linux/systemctl-default b/tldr/linux/systemctl-default index 187d0156..49c033f8 100644 --- a/tldr/linux/systemctl-default +++ b/tldr/linux/systemctl-default @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl default > Enter system default mode. -> More information: . +> More information: . - Enter default mode as a blocking operation: diff --git a/tldr/linux/systemctl-get-default b/tldr/linux/systemctl-get-default index 6339674e..7188298a 100644 --- a/tldr/linux/systemctl-get-default +++ b/tldr/linux/systemctl-get-default @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl get-default > Display the default target (runlevel) that the system will boot into. -> More information: . +> More information: . - Check the default target on your system: diff --git a/tldr/linux/systemctl-hibernate b/tldr/linux/systemctl-hibernate new file mode 100644 index 00000000..a31f6ba8 --- /dev/null +++ b/tldr/linux/systemctl-hibernate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl hibernate + +> Hibernate the system by saving the current state to disk and powering off. +> More information: . + +- Hibernate the system immediately: + +`systemctl hibernate` + +- Force hibernation even if inhibitors are present: + +`systemctl hibernate --force` + +- Hibernate the system without sending a message to logged-in users: + +`systemctl hibernate --no-wall` diff --git a/tldr/linux/systemctl-hybrid-sleep b/tldr/linux/systemctl-hybrid-sleep new file mode 100644 index 00000000..d62c7e64 --- /dev/null +++ b/tldr/linux/systemctl-hybrid-sleep @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl hybrid-sleep + +> Put the system into hybrid sleep, which combines suspend-to-RAM and hibernate. +> More information: . + +- Put the system into hybrid sleep immediately: + +`systemctl hybrid-sleep` + +- Force hybrid sleep even if inhibitors are present: + +`systemctl hybrid-sleep --force` + +- Put the system into hybrid sleep without sending a wall message to logged-in users: + +`systemctl hybrid-sleep --no-wall` diff --git a/tldr/linux/systemctl-is-active b/tldr/linux/systemctl-is-active index 2d1cc359..2fe90d94 100644 --- a/tldr/linux/systemctl-is-active +++ b/tldr/linux/systemctl-is-active @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl is-active > Check if one or more systemd units are active. -> More information: . +> More information: . - Check whether a unit is active: diff --git a/tldr/linux/systemctl-is-enabled b/tldr/linux/systemctl-is-enabled index 3b21a7bc..2ed44d09 100644 --- a/tldr/linux/systemctl-is-enabled +++ b/tldr/linux/systemctl-is-enabled @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Check whether unit files are enabled. > See also: `systemctl enable`, `systemctl disable`. -> More information: . +> More information: . - Show the enablement state: diff --git a/tldr/linux/systemctl-is-system-running b/tldr/linux/systemctl-is-system-running new file mode 100644 index 00000000..160c651a --- /dev/null +++ b/tldr/linux/systemctl-is-system-running @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl is-system-running + +> Check the current state of the system. +> More information: . + +- Check whether the system is operational and print the current state: + +`systemctl is-system-running` + +- Check and print the current state quietly (no output, only exit status): + +`systemctl is-system-running --quiet` + +- Wait until the boot process is completed before printing the current state: + +`systemctl is-system-running --wait` diff --git a/tldr/linux/systemctl-list-automounts b/tldr/linux/systemctl-list-automounts index 7ba807e8..26bf4a39 100644 --- a/tldr/linux/systemctl-list-automounts +++ b/tldr/linux/systemctl-list-automounts @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > List automount units currently in memory, showing mount paths and unit names. > See also: `systemctl list-units`, `systemctl list-unit-files`. -> More information: . +> More information: . - List automount units currently in memory: diff --git a/tldr/linux/systemctl-list-jobs b/tldr/linux/systemctl-list-jobs index 3a043dab..0e2a12b8 100644 --- a/tldr/linux/systemctl-list-jobs +++ b/tldr/linux/systemctl-list-jobs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl list-jobs > List of active systemd jobs that are currently queued or running on the system. -> More information: . +> More information: . - List all active jobs: diff --git a/tldr/linux/systemctl-list-unit-files b/tldr/linux/systemctl-list-unit-files index df043094..ff9bf5bb 100644 --- a/tldr/linux/systemctl-list-unit-files +++ b/tldr/linux/systemctl-list-unit-files @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > List installed unit files and their enablement states. > See also: `systemctl list-units` for listing units currently loaded in memory. -> More information: . +> More information: . - List installed unit files and their states: diff --git a/tldr/linux/systemctl-list-units b/tldr/linux/systemctl-list-units index a8f237b2..7c5959e7 100644 --- a/tldr/linux/systemctl-list-units +++ b/tldr/linux/systemctl-list-units @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > List units that systemd currently has in memory. > See also: `systemctl list-unit-files` for listing installed unit files. -> More information: . +> More information: . - List units which are active, have pending jobs, or have failed: diff --git a/tldr/linux/systemctl-preset b/tldr/linux/systemctl-preset index 534c7025..d4a2141c 100644 --- a/tldr/linux/systemctl-preset +++ b/tldr/linux/systemctl-preset @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Reset the enablement state of unit files to the defaults specified in preset policy files. > See also: `systemctl preset-all`, `systemctl list-unit-files`. -> More information: . +> More information: . - Reset the enablement state to preset defaults: diff --git a/tldr/linux/systemctl-preset-all b/tldr/linux/systemctl-preset-all index 1e1a3c31..12b3c71a 100644 --- a/tldr/linux/systemctl-preset-all +++ b/tldr/linux/systemctl-preset-all @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Reset the enablement state of all installed units to the defaults specified in preset policy files. > See also: `systemctl preset`, `systemctl list-unit-files`. -> More information: . +> More information: . - Reset the enablement state of all installed units: diff --git a/tldr/linux/systemctl-set-environment b/tldr/linux/systemctl-set-environment index bcb19866..5afc9ebf 100644 --- a/tldr/linux/systemctl-set-environment +++ b/tldr/linux/systemctl-set-environment @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl set-environment > Set one or more service manager environment variables. -> More information: . +> More information: . - Set a single environment variable: diff --git a/tldr/linux/systemctl-show-environment b/tldr/linux/systemctl-show-environment index 04892b90..90a970dd 100644 --- a/tldr/linux/systemctl-show-environment +++ b/tldr/linux/systemctl-show-environment @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl show-environment > Display systemd environment blocks. -> More information: . +> More information: . - Display the environment block for the system: diff --git a/tldr/linux/systemctl-soft-reboot b/tldr/linux/systemctl-soft-reboot index 200ccade..a87dc7e2 100644 --- a/tldr/linux/systemctl-soft-reboot +++ b/tldr/linux/systemctl-soft-reboot @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl soft-reboot > Shut down and reboot userspace, leaving the kernel running. -> More information: . +> More information: . - Perform a soft reboot immediately: diff --git a/tldr/linux/systemctl-suspend-then-hibernate b/tldr/linux/systemctl-suspend-then-hibernate index e6ca49ec..a84e0c92 100644 --- a/tldr/linux/systemctl-suspend-then-hibernate +++ b/tldr/linux/systemctl-suspend-then-hibernate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl suspend-then-hibernate > Suspend the system, then automatically hibernate after a period of inactivity. -> More information: . +> More information: . - Suspend the system and hibernate after the configured delay: diff --git a/tldr/linux/systemctl-switch-root b/tldr/linux/systemctl-switch-root index 20cd0e6c..c4b7c6bd 100644 --- a/tldr/linux/systemctl-switch-root +++ b/tldr/linux/systemctl-switch-root @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl switch-root > Switch to a new root filesystem and execute a new system manager. -> More information: . +> More information: . - Switch to a new root filesystem and execute its default init system: diff --git a/tldr/linux/systemctl-try-reload-or-restart b/tldr/linux/systemctl-try-reload-or-restart index 704a38ea..7ec0f4b1 100644 --- a/tldr/linux/systemctl-try-reload-or-restart +++ b/tldr/linux/systemctl-try-reload-or-restart @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl try-reload-or-restart > Reload one or more units if they support it; otherwise restart them. -> More information: . +> More information: . - Reload or restart a specific unit: diff --git a/tldr/linux/systemctl-try-restart b/tldr/linux/systemctl-try-restart index 1c8fa270..0404c3dc 100644 --- a/tldr/linux/systemctl-try-restart +++ b/tldr/linux/systemctl-try-restart @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl try-restart > Restart one or more units only if they are currently running. -> More information: . +> More information: . - Restart a specific unit if it is running: diff --git a/tldr/linux/systemctl-unset-environment b/tldr/linux/systemctl-unset-environment index 86c4e49b..1a00b8c7 100644 --- a/tldr/linux/systemctl-unset-environment +++ b/tldr/linux/systemctl-unset-environment @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Unset one or more service manager environment variables. > This undoes the effect of `systemctl set-environment`. -> More information: . +> More information: . - Unset a single environment variable: diff --git a/tldr/linux/timedatectl b/tldr/linux/timedatectl index a2e16759..d23572ba 100644 --- a/tldr/linux/timedatectl +++ b/tldr/linux/timedatectl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # timedatectl > Control the system time and date. -> More information: . +> More information: . - Check the current system clock time: diff --git a/tldr/npm-completion b/tldr/npm-completion index 729f1fc7..a37ea16c 100644 --- a/tldr/npm-completion +++ b/tldr/npm-completion @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm completion > Enable or set up tab-completion for npm commands. -> More information: . +> More information: . - Enable tab-completion for the current shell session: diff --git a/tldr/npm-diff b/tldr/npm-diff index 9322c627..d36c219c 100644 --- a/tldr/npm-diff +++ b/tldr/npm-diff @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Compare package versions from the `npm` registry and show differences. > Similar to `git diff`. -> More information: . +> More information: . - Compare two specific package versions: diff --git a/tldr/npm-dist-tag b/tldr/npm-dist-tag index f02605ff..b8fe5225 100644 --- a/tldr/npm-dist-tag +++ b/tldr/npm-dist-tag @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm dist-tag > Manage distribution tags on packages. -> More information: . +> More information: . - List all distribution tags for a package: diff --git a/tldr/npm-edit b/tldr/npm-edit index 5760d5fc..ff574db5 100644 --- a/tldr/npm-edit +++ b/tldr/npm-edit @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Select a dependency in the current project and open the package folder in the default editor (`$EDITOR`). > After editing, the package is rebuilt to pick up any changes in compiled packages. -> More information: . +> More information: . - Edit a locally installed package in the default editor: diff --git a/tldr/npm-prefix b/tldr/npm-prefix new file mode 100644 index 00000000..17a88dcb --- /dev/null +++ b/tldr/npm-prefix @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm prefix + +> Print the local or global prefix to `stdout`. +> More information: . + +- Print the local prefix: + +`npm prefix` + +- Print the global prefix: + +`npm prefix {{[-g|--global]}}` diff --git a/tldr/zapier-test b/tldr/zapier-test new file mode 100644 index 00000000..8b8e1ab8 --- /dev/null +++ b/tldr/zapier-test @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zapier test + +> Test a Zapier integration via the `test` script in your `package.json`. +> More information: . + +- Test an integration: + +`zapier test` + +- Test an integration while skipping validation: + +`zapier test --skip-validate` + +- Test an integration with additional debug output: + +`zapier test {{[-d|--debug]}}` diff --git a/tldr/zapier-validate b/tldr/zapier-validate new file mode 100644 index 00000000..a534fec2 --- /dev/null +++ b/tldr/zapier-validate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zapier validate + +> Validate a Zapier integration. +> More information: . + +- Validate an integration: + +`zapier validate` + +- Validate an integration without style checks: + +`zapier validate --without-style` + +- Validate an integration without running the build script: + +`zapier validate --skip-build` + +- Validate an integration with additional debug output: + +`zapier validate {{[-d|--debug]}}` + +- Validate an integration with a different output structure: + +`zapier validate {{[-f|--format]}} {{plain|json|raw|row|table}}` diff --git a/tldr/zapier-versions b/tldr/zapier-versions new file mode 100644 index 00000000..55d8688b --- /dev/null +++ b/tldr/zapier-versions @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zapier versions + +> List the versions for a Zapier integration. +> More information: . + +- List the versions for an integration: + +`zapier versions` + +- Include deprecated versions: + +`zapier versions {{[-a|--all]}}` + +- Display additional debug output: + +`zapier versions {{[-d|--debug]}}` + +- List the versions with a different output structure: + +`zapier versions {{[-f|--format]}} {{plain|json|raw|row|table}}`