mirror of
https://github.com/nvbn/thefuck.git
synced 2024-10-06 02:41:10 +01:00
132 lines
3.0 KiB
Markdown
132 lines
3.0 KiB
Markdown
# The Fuck [](https://travis-ci.org/nvbn/thefuck)
|
|
|
|
Magnificent app which corrects your previous console command,
|
|
inspired by [@liamosaur](https://twitter.com/liamosaur/status/506975850596536320)
|
|
twit.
|
|
|
|
Few examples:
|
|
|
|
```bash
|
|
➜ apt-get install vim
|
|
E: Could not open lock file /var/lib/dpkg/lock - open (13: Permission denied)
|
|
E: Unable to lock the administration directory (/var/lib/dpkg/), are you root?
|
|
|
|
➜ fuck
|
|
[sudo] password for nvbn:
|
|
Reading package lists... Done
|
|
...
|
|
|
|
➜ git push
|
|
fatal: The current branch master has no upstream branch.
|
|
To push the current branch and set the remote as upstream, use
|
|
|
|
git push --set-upstream origin master
|
|
|
|
|
|
➜ fuck
|
|
Counting objects: 9, done.
|
|
...
|
|
|
|
➜ puthon
|
|
No command 'puthon' found, did you mean:
|
|
Command 'python' from package 'python-minimal' (main)
|
|
Command 'python' from package 'python3' (main)
|
|
zsh: command not found: puthon
|
|
|
|
➜ fuck
|
|
Python 3.4.2 (default, Oct 8 2014, 13:08:17)
|
|
...
|
|
|
|
➜ git brnch
|
|
git: 'brnch' is not a git command. See 'git --help'.
|
|
|
|
Did you mean this?
|
|
branch
|
|
|
|
➜ fuck
|
|
* master
|
|
```
|
|
|
|
## Installation
|
|
|
|
Install `The Fuck`:
|
|
|
|
```bash
|
|
sudo pip install thefuck
|
|
```
|
|
|
|
And add to `.bashrc` or `.zshrc`:
|
|
|
|
```bash
|
|
alias fuck='$(thefuck $(fc -ln -1))'
|
|
```
|
|
|
|
Or in `config.fish`:
|
|
|
|
```fish
|
|
function fuck
|
|
eval (thefuck (history | head -n1))
|
|
end
|
|
```
|
|
|
|
## How it works
|
|
|
|
The Fuck tries to match rule for the previous command, create new command
|
|
using matched rule and run it. Rules enabled by default:
|
|
|
|
* `git_no_command` – fixes wrong git commands like `git brnch`;
|
|
* `git_push` – adds `--set-upstream origin $branch` to previous failed `git push`;
|
|
* `no_command` – fixes wrong console commands, for example `vom/vim`;
|
|
* `sudo` – prepends `sudo` to previous command if it failed because of permissions.
|
|
|
|
## Creating your own rules
|
|
|
|
For adding your own rule you should create `your-rule-name.py`
|
|
in `~/.thefuck/rules`. Rule should contain two functions:
|
|
`match(command: Command, settings: Settings) -> bool`
|
|
and `get_new_command(command: Command, settings: Settings) -> str`.
|
|
|
|
`Command` have three attributes: `script`, `stdout` and `stderr`.
|
|
|
|
`Settings` is `~/.thefuck/settings.py`.
|
|
|
|
Simple example of the rule for running script with `sudo`:
|
|
|
|
```python
|
|
def match(command, settings):
|
|
return ('permission denied' in command.stderr.lower()
|
|
or 'EACCES' in command.stderr)
|
|
|
|
|
|
def get_new_command(command, settings):
|
|
return 'sudo {}'.format(command.script)
|
|
```
|
|
|
|
[More examples of rules](https://github.com/nvbn/thefuck/tree/master/thefuck/rules),
|
|
[utility functions for rules](https://github.com/nvbn/thefuck/tree/master/thefuck/utils.py).
|
|
|
|
## Settings
|
|
|
|
The Fuck have a few settings parameters:
|
|
|
|
* `rules` – list of enabled rules, by default all;
|
|
* `command_not_found` – path to `command_not_found` binary,
|
|
by default `/usr/lib/command-not-found`.
|
|
|
|
## Developing
|
|
|
|
Install `The Fuck` for development:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
python setup.py develop
|
|
```
|
|
|
|
Run tests:
|
|
|
|
```bash
|
|
py.test
|
|
```
|
|
|
|
## License MIT
|