sudo: add README file (#7177)

This commit is contained in:
Griko Nibras 2018-10-01 17:05:34 +07:00 committed by Marc Cornellà
parent b4007b5400
commit 441595d036

57
plugins/sudo/README.md Normal file
View File

@ -0,0 +1,57 @@
# sudo
Easily prefix your current or previous commands with `sudo` by pressing <kbd>esc</kbd> twice
## Enabling the plugin
1. Open your `.zshrc` file and add `sudo` in the plugins section:
```zsh
plugins=(
# all your enabled plugins
sudo
)
```
2. Reload the source file or restart your Terminal session:
```console
$ source ~/.zshrc
$
```
## Usage examples
### Current typed commands
Say you have typed a long command and forgot to add `sudo` in front:
```console
$ apt-get install build-essential
```
By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo` prefixed without typing:
```console
$ sudo apt-get install build-essential
```
### Previous executed commands
Say you want to delete a system file and denied:
```console
$ rm some-system-file.txt
-su: some-system-file.txt: Permission denied
$
```
By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo` prefixed without typing:
```console
$ rm some-system-file.txt
-su: some-system-file.txt: Permission denied
$ sudo rm some-system-file.txt
Password:
$
```