1
0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-02-11 05:39:45 +08:00

Compare commits

...

4 Commits

Author SHA1 Message Date
Xlebp Rjanoi
5029149ee3
Merge 6d7eb3746c into 41c5b9677a 2026-02-09 21:18:59 +04:00
dependabot[bot]
41c5b9677a
chore(deps): bump github/codeql-action from 4.32.0 to 4.32.2 (#13558)
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 4.32.0 to 4.32.2.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](b20883b0cd...45cbd0c69e)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-version: 4.32.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-02-08 21:09:55 +01:00
dependabot[bot]
116be8badd
chore(deps): bump step-security/harden-runner from 2.14.1 to 2.14.2 (#13557)
Bumps [step-security/harden-runner](https://github.com/step-security/harden-runner) from 2.14.1 to 2.14.2.
- [Release notes](https://github.com/step-security/harden-runner/releases)
- [Commits](e3f713f2d8...5ef0c079ce)

---
updated-dependencies:
- dependency-name: step-security/harden-runner
  dependency-version: 2.14.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-02-08 21:09:10 +01:00
xlebpushek
6d7eb3746c feat: support custom prefix in sudo plugin and update README accordingly
feat: add configurable prefix support to sudo plugin with alias reminder

- Introduced ZSH_SUDO_PLUGIN_PREFIX variable to allow custom command prefix instead of default 'sudo'
- Updated command substitution logic to handle prefix and prefix -e (sudoedit) properly
- Enhanced README with usage examples and a note about creating alias for custom prefixes
- Maintains default behavior when no prefix is specified
2025-06-08 14:52:40 +04:00
7 changed files with 59 additions and 40 deletions

View File

@ -13,7 +13,7 @@ jobs:
contents: write # this is needed to push commits and branches contents: write # this is needed to push commits and branches
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit

View File

@ -26,7 +26,7 @@ jobs:
- macos-latest - macos-latest
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit
@ -47,7 +47,7 @@ jobs:
- test - test
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit

View File

@ -24,7 +24,7 @@ jobs:
if: github.repository == 'ohmyzsh/ohmyzsh' if: github.repository == 'ohmyzsh/ohmyzsh'
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit

View File

@ -17,7 +17,7 @@ jobs:
if: github.repository == 'ohmyzsh/ohmyzsh' if: github.repository == 'ohmyzsh/ohmyzsh'
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit
- name: Authenticate as @ohmyzsh - name: Authenticate as @ohmyzsh

View File

@ -36,7 +36,7 @@ jobs:
steps: steps:
- name: Harden the runner (Audit all outbound calls) - name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1 uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
with: with:
egress-policy: audit egress-policy: audit
@ -60,6 +60,6 @@ jobs:
retention-days: 5 retention-days: 5
- name: "Upload to code-scanning" - name: "Upload to code-scanning"
uses: github/codeql-action/upload-sarif@b20883b0cd1f46c72ae0ba6d1090936928f9fa30 # v4.32.0 uses: github/codeql-action/upload-sarif@45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2 # v4.32.2
with: with:
sarif_file: results.sarif sarif_file: results.sarif

View File

@ -1,30 +1,30 @@
# sudo # sudo
Easily prefix your current or previous commands with `sudo` by pressing <kbd>esc</kbd> twice. Easily prefix your current or previous commands with `sudo` (or a custom prefix) by pressing <kbd>esc</kbd> twice.
To use it, add `sudo` to the plugins array in your zshrc file: To use it, add `sudo` to the plugins array in your zshrc file:
```zsh ```zsh
plugins=(... sudo) plugins=(... sudo)
``` ````
## Usage ## Usage
### Current typed commands ### Current typed commands
Say you have typed a long command and forgot to add `sudo` in front: Say you have typed a long command and forgot to add the prefix (default: `sudo`) in front:
```console ```console
$ apt-get install build-essential $ apt-get install build-essential
``` ```
By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo` prefixed without typing: By pressing the <kbd>esc</kbd> key twice, you will have the same command with the prefix (`sudo` by default) added without typing:
```console ```console
$ sudo apt-get install build-essential $ sudo apt-get install build-essential
``` ```
The same happens for editing files with your default editor (defined in `$SUDO_EDITOR`, `$VISUAL` or `$EDITOR`, in that order): The same happens for editing files with your default editor (defined in `$SUDO_EDITOR`, `$VISUAL`, or `$EDITOR`, in that order):
If the editor defined were `vim`: If the editor defined were `vim`:
@ -32,7 +32,7 @@ If the editor defined were `vim`:
$ vim /etc/hosts $ vim /etc/hosts
``` ```
By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo -e` instead of the editor, that would open that editor with root privileges: By pressing the <kbd>esc</kbd> key twice, the command will be replaced with the prefix followed by `-e` (default: `sudo -e`), which opens that editor with root privileges:
```console ```console
$ sudo -e /etc/hosts $ sudo -e /etc/hosts
@ -40,7 +40,7 @@ $ sudo -e /etc/hosts
### Previous executed commands ### Previous executed commands
Say you want to delete a system file and denied: Say you want to delete a system file and get a permission denied error:
```console ```console
$ rm some-system-file.txt $ rm some-system-file.txt
@ -48,21 +48,20 @@ $ rm some-system-file.txt
$ $
``` ```
By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo` prefixed without typing: By pressing the <kbd>esc</kbd> key twice, the plugin will take the last executed command and prefix it with `sudo` (or your configured prefix):
```console ```console
$ rm some-system-file.txt
-su: some-system-file.txt: Permission denied
$ sudo rm some-system-file.txt $ sudo rm some-system-file.txt
Password: Password:
$ $
``` ```
The same happens for file editing, as told before. The same applies for file editing commands, as described above.
## Key binding ## Key binding
By default, the `sudo` plugin uses <kbd>Esc</kbd><kbd>Esc</kbd> as the trigger. By default, the plugin uses <kbd>Esc</kbd><kbd>Esc</kbd> as the trigger.
If you want to change it, you can use the `bindkey` command to bind it to a different key: If you want to change it, you can use the `bindkey` command to bind it to a different key:
```sh ```sh
@ -71,5 +70,23 @@ bindkey -M vicmd '<seq>' sudo-command-line
bindkey -M viins '<seq>' sudo-command-line bindkey -M viins '<seq>' sudo-command-line
``` ```
where `<seq>` is the sequence you want to use. You can find the keyboard sequence where `<seq>` is the key sequence you want to use. You can find the keyboard sequence by running `cat` and pressing the desired key combination.
by running `cat` and pressing the keyboard combination you want to use.
## Configuration
You can override the default prefix (`sudo`) by setting the `ZSH_SUDO_PLUGIN_PREFIX` environment variable in your `.zshrc`:
```zsh
export ZSH_SUDO_PLUGIN_PREFIX="doas"
```
This will make the plugin prefix commands with `doas` instead of `sudo`.
**Important:** If you use a custom prefix different from `sudo`, make sure to create an alias named after that prefix pointing to `sudo`, for example:
```zsh
alias doas='sudo'
```
This ensures proper command substitution and consistent behavior.

View File

@ -2,7 +2,7 @@
# Description # Description
# ----------- # -----------
# #
# sudo or sudo -e (replacement for sudoedit) will be inserted before the command # [prefix](by default: sudo) or [prefix](by default: sudo) -e (replacement for sudoedit) will be inserted before the command
# #
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Authors # Authors
@ -12,10 +12,11 @@
# * Subhaditya Nath <github.com/subnut> # * Subhaditya Nath <github.com/subnut>
# * Marc Cornellà <github.com/mcornella> # * Marc Cornellà <github.com/mcornella>
# * Carlo Sala <carlosalag@protonmail.com> # * Carlo Sala <carlosalag@protonmail.com>
# * Xlebp Rjanoi <github.com/xlebpushek>
# #
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
__sudo-replace-buffer() { __prefix-replace-buffer() {
local old=$1 new=$2 space=${2:+ } local old=$1 new=$2 space=${2:+ }
# if the cursor is positioned in the $old part of the text, make # if the cursor is positioned in the $old part of the text, make
@ -29,8 +30,8 @@ __sudo-replace-buffer() {
fi fi
} }
sudo-command-line() { prefix-command-line() {
# If line is empty, get the last run command from history # If buffer is empty, use last history entry
[[ -z $BUFFER ]] && LBUFFER="$(fc -ln -1)" [[ -z $BUFFER ]] && LBUFFER="$(fc -ln -1)"
# Save beginning space # Save beginning space
@ -44,13 +45,13 @@ sudo-command-line() {
# If $SUDO_EDITOR or $VISUAL are defined, then use that as $EDITOR # If $SUDO_EDITOR or $VISUAL are defined, then use that as $EDITOR
# Else use the default $EDITOR # Else use the default $EDITOR
local EDITOR=${SUDO_EDITOR:-${VISUAL:-$EDITOR}} local EDITOR=${SUDO_EDITOR:-${VISUAL:-$EDITOR}}
local PREFIX=${ZSH_SUDO_PLUGIN_PREFIX:-sudo}
# If $EDITOR is not set, just toggle the sudo prefix on and off
if [[ -z "$EDITOR" ]]; then if [[ -z "$EDITOR" ]]; then
case "$BUFFER" in case "$BUFFER" in
sudo\ -e\ *) __sudo-replace-buffer "sudo -e" "" ;; $PREFIX\ -e\ *) __prefix-replace-buffer "$PREFIX -e" "" ;;
sudo\ *) __sudo-replace-buffer "sudo" "" ;; $PREFIX\ *) __prefix-replace-buffer "$PREFIX" "" ;;
*) LBUFFER="sudo $LBUFFER" ;; *) LBUFFER="$PREFIX $LBUFFER" ;;
esac esac
return return
fi fi
@ -79,17 +80,17 @@ sudo-command-line() {
if [[ "$realcmd" = (\$EDITOR|$editorcmd|${editorcmd:c}) \ if [[ "$realcmd" = (\$EDITOR|$editorcmd|${editorcmd:c}) \
|| "${realcmd:c}" = ($editorcmd|${editorcmd:c}) ]] \ || "${realcmd:c}" = ($editorcmd|${editorcmd:c}) ]] \
|| builtin which -a "$realcmd" | command grep -Fx -q "$editorcmd"; then || builtin which -a "$realcmd" | command grep -Fx -q "$editorcmd"; then
__sudo-replace-buffer "$cmd" "sudo -e" __prefix-replace-buffer "$cmd" "$PREFIX -e"
return return
fi fi
# Check for editor commands in the typed command and replace accordingly # Check for editor commands in the typed command and replace accordingly
case "$BUFFER" in case "$BUFFER" in
$editorcmd\ *) __sudo-replace-buffer "$editorcmd" "sudo -e" ;; $editorcmd\ *) __prefix-replace-buffer "$editorcmd" "$PREFIX -e" ;;
\$EDITOR\ *) __sudo-replace-buffer '$EDITOR' "sudo -e" ;; \$EDITOR\ *) __prefix-replace-buffer '$EDITOR' "$PREFIX -e" ;;
sudo\ -e\ *) __sudo-replace-buffer "sudo -e" "$EDITOR" ;; $PREFIX\ -e\ *) __prefix-replace-buffer "$PREFIX -e" "$EDITOR" ;;
sudo\ *) __sudo-replace-buffer "sudo" "" ;; $PREFIX\ *) __prefix-replace-buffer "$PREFIX" "" ;;
*) LBUFFER="sudo $LBUFFER" ;; *) LBUFFER="$PREFIX $LBUFFER" ;;
esac esac
} always { } always {
# Preserve beginning space # Preserve beginning space
@ -100,9 +101,10 @@ sudo-command-line() {
} }
} }
zle -N sudo-command-line zle -N prefix-command-line
# Defined shortcut keys: [Esc] [Esc] # Defined shortcut keys: [Esc] [Esc]
bindkey -M emacs '\e\e' sudo-command-line bindkey -M emacs '\e\e' prefix-command-line
bindkey -M vicmd '\e\e' sudo-command-line bindkey -M vicmd '\e\e' prefix-command-line
bindkey -M viins '\e\e' sudo-command-line bindkey -M viins '\e\e' prefix-command-line