2016-04-01 01:58:14 +01:00
# The Fuck [![Version][version-badge]][version-link] [![Build Status][travis-badge]][travis-link] [![Windows Build Status][appveyor-badge]][appveyor-link] [![Coverage][coverage-badge]][coverage-link] [![MIT License][license-badge]](LICENSE.md)
2015-04-08 17:15:49 +01:00
2015-04-08 17:20:38 +01:00
Magnificent app which corrects your previous console command,
2015-04-20 17:19:34 +01:00
inspired by a [@liamosaur ](https://twitter.com/liamosaur/ )
[tweet ](https://twitter.com/liamosaur/status/506975850596536320 ).
2015-04-08 17:15:49 +01:00
2017-08-26 12:31:09 +01:00
The Fuck is too slow? [Try experimental instant mode! ](#experimental-instant-mode )
2016-04-01 01:48:22 +01:00
[![gif with examples][examples-link]][examples-link]
2015-07-19 19:53:08 +01:00
Few more examples:
2015-04-08 17:15:49 +01:00
```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
2015-07-31 13:36:08 +01:00
sudo apt-get install vim [enter/↑/↓/ctrl+c]
2015-04-17 21:04:09 +01:00
[sudo] password for nvbn:
2015-04-08 17:15:49 +01:00
Reading package lists... Done
...
2015-04-19 03:31:43 +01:00
```
2015-04-08 17:15:49 +01:00
2015-04-19 03:31:43 +01:00
```bash
2015-04-08 17:15:49 +01:00
➜ 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
2015-07-31 13:36:08 +01:00
git push --set-upstream origin master [enter/↑/↓/ctrl+c]
2015-04-08 17:15:49 +01:00
Counting objects: 9, done.
...
2015-04-19 03:31:43 +01:00
```
2015-04-08 18:00:03 +01:00
2015-04-19 03:31:43 +01:00
```bash
2015-04-08 18:00:03 +01:00
➜ 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
2015-07-31 13:36:08 +01:00
python [enter/↑/↓/ctrl+c]
2015-04-08 18:00:03 +01:00
Python 3.4.2 (default, Oct 8 2014, 13:08:17)
...
2015-04-19 03:31:43 +01:00
```
2015-04-08 20:20:11 +01:00
2015-04-19 03:31:43 +01:00
```bash
2015-04-08 20:20:11 +01:00
➜ git brnch
git: 'brnch' is not a git command. See 'git --help'.
Did you mean this?
2016-03-24 01:47:09 +00:00
branch
2015-04-08 20:20:11 +01:00
➜ fuck
2015-07-31 13:36:08 +01:00
git branch [enter/↑/↓/ctrl+c]
2015-04-08 20:20:11 +01:00
* master
2015-04-19 03:31:43 +01:00
```
2015-04-18 22:19:34 +01:00
2015-04-19 03:31:43 +01:00
```bash
2015-04-18 22:19:34 +01:00
➜ lein rpl
'rpl' is not a task. See 'lein help'.
Did you mean this?
repl
➜ fuck
2015-07-31 13:36:08 +01:00
lein repl [enter/↑/↓/ctrl+c]
2015-04-18 22:19:34 +01:00
nREPL server started on port 54848 on host 127.0.0.1 - nrepl://127.0.0.1:54848
REPL-y 0.3.1
...
2015-04-08 17:15:49 +01:00
```
2015-07-20 20:06:59 +01:00
If you are not scared to blindly run the changed command, there is a `require_confirmation`
2015-04-21 13:46:38 +01:00
[settings ](#settings ) option:
2015-04-21 04:30:15 +01:00
```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
2015-07-20 20:06:59 +01:00
sudo apt-get install vim
2015-04-21 04:30:15 +01:00
[sudo] password for nvbn:
Reading package lists... Done
...
```
2015-04-19 11:57:59 +01:00
## Requirements
2017-09-02 10:02:49 +01:00
- python (3.3+)
2015-04-19 11:57:59 +01:00
- pip
- python-dev
2016-05-04 02:50:14 +01:00
## Installation
2015-08-24 18:25:59 +01:00
2016-05-04 02:50:14 +01:00
On OS X you can install `The Fuck` with [Homebrew][homebrew]:
```bash
brew install thefuck
```
2016-05-09 16:54:40 +01:00
On Ubuntu you can install `The Fuck` with:
```bash
sudo apt update
sudo apt install python3-dev python3-pip
2017-05-29 09:11:15 +01:00
sudo pip3 install thefuck
2016-05-09 16:54:40 +01:00
```
2015-04-08 17:15:49 +01:00
2016-05-09 16:54:40 +01:00
On other systems you can install `The Fuck` with `pip` :
2015-04-08 17:15:49 +01:00
```bash
2017-05-29 09:11:15 +01:00
pip install thefuck
2015-04-08 17:15:49 +01:00
```
2015-04-27 06:56:17 +01:00
[Or using an OS package manager (OS X, Ubuntu, Arch). ](https://github.com/nvbn/thefuck/wiki/Installation )
2015-04-22 22:00:18 +01:00
2017-09-27 17:21:07 +01:00
< a href = '#manual-installation' name = 'manual-installation' > #< / a >
2015-07-20 19:15:34 +01:00
You should place this command in your `.bash_profile` , `.bashrc` , `.zshrc` or other startup script:
2015-04-08 17:15:49 +01:00
```bash
2017-03-13 16:22:58 +00:00
eval $(thefuck --alias)
2015-04-23 10:26:19 +01:00
# You can use whatever you want as an alias, like for Mondays:
2017-03-13 16:22:58 +00:00
eval $(thefuck --alias FUCK)
2015-04-30 19:43:08 +01:00
```
2015-07-20 19:27:19 +01:00
[Or in your shell config (Bash, Zsh, Fish, Powershell, tcsh). ](https://github.com/nvbn/thefuck/wiki/Shell-aliases )
2015-04-20 06:11:29 +01:00
2015-04-20 14:03:18 +01:00
Changes will be available only in a new shell session.
2015-06-02 04:11:29 +01:00
To make them available immediately, run `source ~/.bashrc` (or your shell config file like `.zshrc` ).
2015-04-18 21:58:53 +01:00
2017-08-26 03:57:16 +01:00
If you want to run fixed command without confirmation you can use `-y` option:
2017-03-13 15:59:29 +00:00
```bash
2017-08-26 03:57:16 +01:00
fuck -y
```
If you want to fix commands recursively until success you can use `-r` option:
```bash
fuck -r
2017-03-13 15:59:29 +00:00
```
2015-04-19 11:57:59 +01:00
## Update
```bash
2017-05-29 09:11:15 +01:00
pip install thefuck --upgrade
2015-04-19 11:57:59 +01:00
```
2015-07-20 12:40:07 +01:00
**Aliases changed in 1.34.**
2015-04-17 20:51:13 +01:00
## How it works
2015-05-09 18:26:35 +01:00
The Fuck tries to match a rule for the previous command, creates a new command
using the matched rule and runs it. Rules enabled by default are as follows:
2015-04-17 20:51:13 +01:00
2016-10-03 05:30:48 +01:00
* `ag_literal` – adds `-Q` to `ag` when suggested;
2016-10-03 05:41:34 +01:00
* `aws_cli` – fixes misspelled commands like `aws dynamdb scan` ;
2015-06-06 16:06:10 +01:00
* `cargo` – runs `cargo build` instead of `cargo` ;
* `cargo_no_command` – fixes wrongs commands like `cargo buid` ;
2015-05-20 00:50:08 +01:00
* `cd_correction` – spellchecks and correct failed cd commands;
2015-04-24 07:52:39 +01:00
* `cd_mkdir` – creates directories before cd'ing into them;
2015-05-20 00:50:08 +01:00
* `cd_parent` – changes `cd..` to `cd ..` ;
2016-04-11 14:13:41 +01:00
* `chmod_x` – add execution bit;
2015-05-20 00:50:08 +01:00
* `composer_not_command` – fixes composer command name;
2015-04-21 04:34:34 +01:00
* `cp_omitting_directory` – adds `-a` when you `cp` directory;
2015-07-20 12:06:57 +01:00
* `cpp11` – adds missing `-std=c++11` to `g++` or `clang++` ;
2015-07-25 22:14:10 +01:00
* `dirty_untar` – fixes `tar x` command that untarred in the current directory;
* `dirty_unzip` – fixes `unzip` command that unzipped in the current directory;
2015-05-20 22:49:56 +01:00
* `django_south_ghost` – adds `--delete-ghost-migrations` to failed because ghosts django south migration;
2015-05-20 22:55:23 +01:00
* `django_south_merge` – adds `--merge` to inconsistent django south migration;
2015-07-23 22:12:29 +01:00
* `docker_not_command` – fixes wrong docker commands like `docker tags` ;
2015-07-22 22:16:12 +01:00
* `dry` – fixes repetitions like `git git push` ;
2016-08-13 14:10:12 +01:00
* `fab_command_not_found` – fix misspelled fabric commands;
2015-04-23 07:35:50 +01:00
* `fix_alt_space` – replaces Alt+Space with Space character;
2015-07-29 15:05:46 +01:00
* `fix_file` – opens a file with an error in your `$EDITOR` ;
2017-01-15 14:11:34 +00:00
* `gem_unknown_command` – fixes wrong `gem` commands;
2016-03-18 02:25:03 +00:00
* `git_add` – fixes *"pathspec 'foo' did not match any file(s) known to git."* ;
2017-01-28 18:18:23 +00:00
* `git_add_force` – adds `--force` to `git add <pathspec>...` when paths are .gitignore'd;
2016-09-27 23:42:01 +01:00
* `git_bisect_usage` – fixes `git bisect strt` , `git bisect goood` , `git bisect rset` , etc. when bisecting;
2015-07-19 19:53:08 +01:00
* `git_branch_delete` – changes `git branch -d` to `git branch -D` ;
2016-04-03 03:57:43 +01:00
* `git_branch_exists` – offers `git branch -d foo` , `git branch -D foo` or `git checkout foo` when creating a branch that already exists;
2015-06-02 04:09:45 +01:00
* `git_branch_list` – catches `git branch list` in place of `git branch` and removes created branch;
2015-07-20 17:25:29 +01:00
* `git_checkout` – fixes branch name or creates new branch;
2016-10-03 04:07:50 +01:00
* `git_diff_no_index` – adds `--no-index` to previous `git diff` on untracked files;
2015-05-29 22:38:01 +01:00
* `git_diff_staged` – adds `--staged` to previous `git diff` with unexpected output;
2015-07-22 22:16:12 +01:00
* `git_fix_stash` – fixes `git stash` commands (misspelled subcommand and missing `save` );
2016-10-31 01:15:47 +00:00
* `git_flag_after_filename` – fixes `fatal: bad flag '...' after filename`
2016-03-12 21:51:47 +00:00
* `git_help_aliased` – fixes `git help <alias>` commands replacing < alias > with the aliased command;
2015-07-22 02:44:37 +01:00
* `git_not_command` – fixes wrong git commands like `git brnch` ;
2015-05-20 00:40:36 +01:00
* `git_pull` – sets upstream before executing previous `git pull` ;
2015-07-20 17:47:59 +01:00
* `git_pull_clone` – clones instead of pulling when the repo does not exist;
2016-09-19 11:52:23 +01:00
* `git_pull_uncommitted_changes` – stashes changes before pulling and pops them afterwards;
2015-05-20 00:50:08 +01:00
* `git_push` – adds `--set-upstream origin $branch` to previous failed `git push` ;
2017-10-15 16:30:29 +01:00
* `git_push_different_branch_names` – fixes pushes when local brach name does not match remote branch name;
2015-07-20 18:51:18 +01:00
* `git_push_pull` – runs `git pull` when `push` was rejected;
2017-03-22 10:23:35 +00:00
* `git_push_without_commits` – Creates an initial commit if you forget and only `git add .` , when setting up a new project;
2016-06-23 13:28:37 +01:00
* `git_rebase_no_changes` – runs `git rebase --skip` instead of `git rebase --continue` when there are no changes;
2017-10-08 15:27:23 +01:00
* `git_remote_delete` – replaces `git remote delete remote_name` with `git remote remove remote_name` ;
2016-10-29 20:41:36 +01:00
* `git_rm_local_modifications` – adds `-f` or `--cached` when you try to `rm` a locally modified file;
2016-03-14 21:59:32 +00:00
* `git_rm_recursive` – adds `-r` when you try to `rm` a directory;
2017-02-27 00:16:15 +00:00
* `git_rm_staged` – adds `-f` or `--cached` when you try to `rm` a file with staged changes
2016-10-30 22:07:14 +00:00
* `git_rebase_merge_dir` – offers `git rebase (--continue | --abort | --skip)` or removing the `.git/rebase-merge` dir when a rebase is in progress;
2016-03-04 12:47:07 +00:00
* `git_remote_seturl_add` – runs `git remote add` when `git remote set_url` on nonexistant remote;
2017-01-28 00:43:59 +00:00
* `git_stash` – stashes your local modifications before rebasing or switching branch;
2016-12-11 17:37:09 +00:00
* `git_stash_pop` – adds your local modifications before popping stash, then resets;
2017-01-28 00:38:34 +00:00
* `git_tag_force` – adds `--force` to `git tag <tagname>` when the tag already exists;
2015-10-17 21:35:39 +01:00
* `git_two_dashes` – adds a missing dash to commands like `git commit -amend` or `git rebase -continue` ;
2016-02-08 08:04:19 +00:00
* `go_run` – appends `.go` extension when compiling/running Go programs;
2016-08-13 18:31:33 +01:00
* `gradle_no_task` – fixes not found or ambiguous `gradle` task;
2016-08-13 17:30:46 +01:00
* `gradle_wrapper` – replaces `gradle` with `./gradlew` ;
2016-02-08 08:04:19 +00:00
* `grep_arguments_order` – fixes grep arguments order for situations like `grep -lir . test` ;
2015-07-22 22:16:12 +01:00
* `grep_recursive` – adds `-r` when you trying to `grep` directory;
2016-08-13 19:13:05 +01:00
* `grunt_task_not_found` – fixes misspelled `grunt` commands;
2015-09-01 16:48:55 +01:00
* `gulp_not_task` – fixes misspelled `gulp` tasks;
2015-04-21 04:34:34 +01:00
* `has_exists_script` – prepends `./` when script/binary exists;
2017-11-09 23:42:23 +00:00
* `heroku_multiple_apps` – add `--app <app>` to `heroku` commands like `heroku pg` ;
2015-08-17 15:05:23 +01:00
* `heroku_not_command` – fixes wrong `heroku` commands like `heroku log` ;
2015-07-10 15:58:41 +01:00
* `history` – tries to replace command with most similar command from history;
2017-02-05 09:28:36 +00:00
* `hostscli` – tries to fix `hostscli` usage;
2017-01-09 17:13:37 +00:00
* `ifconfig_device_not_found` – fixes wrong device names like `wlan0` to `wlp2s0` ;
2015-06-26 11:00:16 +01:00
* `java` – removes `.java` extension when running Java programs;
* `javac` – appends missing `.java` when compiling Java files;
2015-04-21 04:34:34 +01:00
* `lein_not_task` – fixes wrong `lein` tasks like `lein rpl` ;
2016-03-02 16:48:20 +00:00
* `ln_no_hard_link` – catches hard link creation on directories, suggest symbolic link;
2016-06-28 01:00:00 +01:00
* `ln_s_order` – fixes `ln -s` arguments order;
2016-10-10 19:55:45 +01:00
* `ls_all` – adds `-A` to `ls` when output is empty;
2015-07-22 22:16:12 +01:00
* `ls_lah` – adds `-lah` to `ls` ;
2015-07-20 12:06:57 +01:00
* `man` – changes manual section;
2015-05-20 00:50:08 +01:00
* `man_no_space` – fixes man commands without spaces, for example `mandiff` ;
2015-07-09 17:00:59 +01:00
* `mercurial` – fixes wrong `hg` commands;
2017-03-13 21:21:34 +00:00
* `missing_space_before_subcommand` – fixes command with missing space like `npminstall` ;
2015-04-21 04:34:34 +01:00
* `mkdir_p` – adds `-p` when you trying to create directory without parent;
2015-08-26 14:01:36 +01:00
* `mvn_no_command` – adds `clean package` to `mvn` ;
2015-09-01 16:48:55 +01:00
* `mvn_unknown_lifecycle_phase` – fixes misspelled lifecycle phases with `mvn` ;
2016-08-13 16:28:45 +01:00
* `npm_missing_script` – fixes `npm` custom script name in `npm run-script <script>` ;
2016-08-13 15:38:40 +01:00
* `npm_run_script` – adds missing `run-script` for custom `npm` scripts;
2016-02-06 12:18:44 +00:00
* `npm_wrong_command` – fixes wrong npm commands like `npm urgrade` ;
2015-04-17 20:51:13 +01:00
* `no_command` – fixes wrong console commands, for example `vom/vim` ;
2015-05-15 17:03:17 +01:00
* `no_such_file` – creates missing directories with `mv` and `cp` commands;
2016-08-12 02:34:06 +01:00
* `open` – either prepends `http://` to address passed to `open` or create a new file or directory and passes it to `open` ;
2015-07-22 22:16:12 +01:00
* `pip_unknown_command` – fixes wrong `pip` commands, for example `pip instatl/pip install` ;
2017-10-10 18:24:38 +01:00
* `php_s` – replaces `-s` by `-S` when trying to run a local php server;
2016-08-14 04:59:26 +01:00
* `port_already_in_use` – kills process that bound port;
2017-10-15 14:51:09 +01:00
* `prove_recursively` – adds `-r` when called with directory;
2015-04-21 04:34:34 +01:00
* `python_command` – prepends `python` when you trying to run not executable/without `./` python script;
2015-06-26 13:37:44 +01:00
* `python_execute` – appends missing `.py` when executing Python files;
2015-09-01 16:48:55 +01:00
* `quotation_marks` – fixes uneven usage of `'` and `"` when containing args';
2017-03-13 18:05:34 +00:00
* `path_from_history` – replaces not found path with similar absolute path from history;
2016-08-13 17:14:55 +01:00
* `react_native_command_unrecognized` – fixes unrecognized `react-native` commands;
2016-09-29 21:43:02 +01:00
* `remove_trailing_cedilla` – remove trailling cedillas `ç` , a common typo for european keyboard layouts;
2015-04-21 04:34:34 +01:00
* `rm_dir` – adds `-rf` when you trying to remove directory;
2017-01-15 13:40:50 +00:00
* `scm_correction` – corrects wrong scm like `hg log` to `git log` ;
2015-07-09 17:35:33 +01:00
* `sed_unterminated_s` – adds missing '/' to `sed` 's `s` commands;
2015-05-20 00:50:08 +01:00
* `sl_ls` – changes `sl` to `ls` ;
2015-04-22 15:52:09 +01:00
* `ssh_known_hosts` – removes host from `known_hosts` on warning;
2015-04-21 05:26:15 +01:00
* `sudo` – prepends `sudo` to previous command if it failed because of permissions;
2017-02-09 15:09:37 +00:00
* `sudo_command_from_user_path` – runs commands from users `$PATH` with `sudo` ;
2015-08-17 15:05:23 +01:00
* `switch_lang` – switches command from your local layout to en;
2015-07-22 22:16:12 +01:00
* `systemctl` – correctly orders parameters of confusing `systemctl` ;
2015-07-04 13:17:33 +01:00
* `test.py` – runs `py.test` instead of `test.py` ;
2015-09-09 08:53:56 +01:00
* `touch` – creates missing directories before "touching";
2015-07-26 20:09:55 +01:00
* `tsuru_login` – runs `tsuru login` if not authenticated or session expired;
2015-08-12 17:23:43 +01:00
* `tsuru_not_command` – fixes wrong `tsuru` commands like `tsuru shell` ;
2015-07-22 22:16:12 +01:00
* `tmux` – fixes `tmux` commands;
2015-09-01 16:48:55 +01:00
* `unknown_command` – fixes hadoop hdfs-style "unknown command", for example adds missing '-' to the command on `hdfs dfs ls` ;
2015-08-19 17:12:54 +01:00
* `vagrant_up` – starts up the vagrant instance;
2016-08-13 18:55:00 +01:00
* `whois` – fixes `whois` command;
* `workon_doesnt_exists` – fixes `virtualenvwrapper` env name os suggests to create new.
2017-02-27 01:26:15 +00:00
* `yarn_alias` – fixes aliased `yarn` commands like `yarn ls` ;
2017-03-04 04:38:20 +00:00
* `yarn_command_not_found` – fixes misspelled `yarn` commands;
2017-03-26 07:12:01 +01:00
* `yarn_command_replaced` – fixes replaced `yarn` commands;
2017-03-10 17:54:15 +00:00
* `yarn_help` – makes it easier to open `yarn` documentation;
2015-05-20 00:50:08 +01:00
Enabled by default only on specific platforms:
2015-09-01 16:10:53 +01:00
* `apt_get` – installs app from apt if it not installed (requires `python-commandnotfound` / `python3-commandnotfound` );
2015-09-01 16:48:55 +01:00
* `apt_get_search` – changes trying to search using `apt-get` with searching using `apt-cache` ;
2016-01-13 18:53:11 +00:00
* `apt_invalid_operation` – fixes invalid `apt` and `apt-get` calls, like `apt-get isntall vim` ;
2017-11-16 19:19:44 +00:00
* `apt_list_upgradable` – helps you run `apt list --upgradable` after `apt update` ;
2017-10-15 15:11:08 +01:00
* `brew_cask_dependency` – installs cask dependencies;
2015-05-01 03:46:58 +01:00
* `brew_install` – fixes formula name for `brew install` ;
2016-10-02 16:17:15 +01:00
* `brew_link` – adds `--overwrite --dry-run` if linking fails;
2016-09-29 22:19:16 +01:00
* `brew_uninstall` – adds `--force` to `brew uninstall` if multiple versions were installed;
2015-05-20 00:50:08 +01:00
* `brew_unknown_command` – fixes wrong brew commands, for example `brew docto/brew doctor` ;
2016-04-21 02:27:39 +01:00
* `brew_update_formula` – turns `brew update <formula>` into `brew upgrade <formula>` ;
2017-10-06 16:13:29 +01:00
* `dnf_no_such_command` – fixes mistyped DNF commands;
2015-09-01 16:48:55 +01:00
* `pacman` – installs app with `pacman` if it is not installed (uses `yaourt` if available);
* `pacman_not_found` – fixes package name with `pacman` or `yaourt` .
2015-04-17 20:51:13 +01:00
2015-04-22 15:08:54 +01:00
Bundled, but not enabled by default:
2015-10-30 15:17:56 +00:00
* `git_push_force` – adds `--force-with-lease` to a `git push` (may conflict with `git_push_pull` );
2015-04-22 15:08:54 +01:00
* `rm_root` – adds `--no-preserve-root` to `rm -rf /` command.
2015-04-17 16:01:30 +01:00
## Creating your own rules
For adding your own rule you should create `your-rule-name.py`
2015-10-16 15:52:03 +01:00
in `~/.config/thefuck/rules` . The rule should contain two functions:
2015-07-27 21:23:26 +01:00
2015-07-20 20:08:46 +01:00
```python
2015-09-07 11:00:29 +01:00
match(command: Command) -> bool
get_new_command(command: Command) -> str | list[str]
2015-07-20 20:08:46 +01:00
```
2015-08-19 10:00:09 +01:00
Also the rule can contain an optional function
```python
2015-09-07 11:00:29 +01:00
side_effect(old_command: Command, fixed_command: str) -> None
2015-08-19 10:00:09 +01:00
```
2015-07-27 21:23:26 +01:00
and optional `enabled_by_default` , `requires_output` and `priority` variables.
2015-04-17 16:01:30 +01:00
2017-08-31 16:59:38 +01:00
`Command` has three attributes: `script` , `output` and `script_parts` .
2016-10-08 11:18:33 +01:00
Rule shouldn't change `Command` .
2015-04-17 16:01:30 +01:00
2015-09-07 11:00:29 +01:00
*Rules api changed in 3.0:* For accessing settings in rule you need to import it with `from thefuck.conf import settings` .
2015-10-16 15:52:03 +01:00
`settings` is a special object filled with `~/.config/thefuck/settings.py` and values from env ([see more below](#settings)).
2015-04-17 16:01:30 +01:00
Simple example of the rule for running script with `sudo` :
```python
2015-09-07 17:13:17 +01:00
def match(command):
2017-08-31 16:59:38 +01:00
return ('permission denied' in command.output.lower()
or 'EACCES' in command.output)
2015-04-17 16:01:30 +01:00
2015-09-07 17:13:17 +01:00
def get_new_command(command):
2015-04-17 16:01:30 +01:00
return 'sudo {}'.format(command.script)
2015-05-07 19:46:50 +01:00
2015-05-01 03:43:55 +01:00
# Optional:
enabled_by_default = True
2015-09-07 17:13:17 +01:00
def side_effect(command, fixed_command):
2015-05-01 03:43:55 +01:00
subprocess.call('chmod 777 .', shell=True)
2015-05-07 19:46:50 +01:00
2015-07-20 18:01:45 +01:00
priority = 1000 # Lower first, default is 1000
2015-07-27 15:39:52 +01:00
requires_output = True
2015-04-17 16:01:30 +01:00
```
[More examples of rules ](https://github.com/nvbn/thefuck/tree/master/thefuck/rules ),
2015-09-07 11:00:29 +01:00
[utility functions for rules ](https://github.com/nvbn/thefuck/tree/master/thefuck/utils.py ),
[app/os-specific helpers ](https://github.com/nvbn/thefuck/tree/master/thefuck/specific/ ).
2015-04-17 16:01:30 +01:00
## Settings
2015-10-16 15:52:03 +01:00
The Fuck has a few settings parameters which can be changed in `$XDG_CONFIG_HOME/thefuck/settings.py` (`$XDG_CONFIG_HOME` defaults to `~/.config` ):
2015-04-17 16:01:30 +01:00
2015-04-22 21:37:11 +01:00
* `rules` – list of enabled rules, by default `thefuck.conf.DEFAULT_RULES` ;
2015-09-06 10:55:59 +01:00
* `exclude_rules` – list of disabled rules, by default `[]` ;
2015-07-19 19:53:08 +01:00
* `require_confirmation` – requires confirmation before running new command, by default `True` ;
2015-04-22 05:03:06 +01:00
* `wait_command` – max amount of time in seconds for getting previous command output;
2015-05-07 12:11:45 +01:00
* `no_colors` – disable colored output;
2015-07-15 05:47:54 +01:00
* `priority` – dict with rules priorities, rule with lower `priority` will be matched first;
2015-10-30 08:23:19 +00:00
* `debug` – enables debug output, by default `False` ;
2016-01-13 19:22:51 +00:00
* `history_limit` – numeric value of how many history commands will be scanned, like `2000` ;
2016-08-13 16:55:11 +01:00
* `alter_history` – push fixed command to history, by default `True` ;
* `wait_slow_command` – max amount of time in seconds for getting previous command output if it in `slow_commands` list;
* `slow_commands` – list of slow commands.
2015-04-17 16:01:30 +01:00
2015-04-29 03:47:15 +01:00
Example of `settings.py` :
```python
rules = ['sudo', 'no_command']
2015-09-06 10:55:59 +01:00
exclude_rules = ['git_push']
2015-04-29 03:47:15 +01:00
require_confirmation = True
wait_command = 10
no_colors = False
2015-05-07 12:11:45 +01:00
priority = {'sudo': 100, 'no_command': 9999}
2015-07-15 05:47:54 +01:00
debug = False
2016-08-13 16:55:11 +01:00
history_limit = 9999
wait_slow_command = 20
slow_commands = ['react-native', 'gradle']
2015-04-29 03:47:15 +01:00
```
2015-04-22 19:18:53 +01:00
Or via environment variables:
2015-04-22 21:37:11 +01:00
* `THEFUCK_RULES` – list of enabled rules, like `DEFAULT_RULES:rm_root` or `sudo:no_command` ;
2016-03-24 01:47:09 +00:00
* `THEFUCK_EXCLUDE_RULES` – list of disabled rules, like `git_pull:git_push` ;
2015-04-22 19:18:53 +01:00
* `THEFUCK_REQUIRE_CONFIRMATION` – require confirmation before running new command, `true/false` ;
* `THEFUCK_WAIT_COMMAND` – max amount of time in seconds for getting previous command output;
2015-05-07 12:11:45 +01:00
* `THEFUCK_NO_COLORS` – disable colored output, `true/false` ;
* `THEFUCK_PRIORITY` – priority of the rules, like `no_command=9999:apt_get=100` ,
2015-07-15 05:47:54 +01:00
rule with lower `priority` will be matched first;
2015-10-22 12:25:00 +01:00
* `THEFUCK_DEBUG` – enables debug output, `true/false` ;
2016-01-13 19:22:51 +00:00
* `THEFUCK_HISTORY_LIMIT` – how many history commands will be scanned, like `2000` ;
2016-08-13 16:55:11 +01:00
* `THEFUCK_ALTER_HISTORY` – push fixed command to history `true/false` ;
* `THEFUCK_WAIT_SLOW_COMMAND` – max amount of time in seconds for getting previous command output if it in `slow_commands` list;
* `THEFUCK_SLOW_COMMANDS` – list of slow commands, like `lein:gradle` .
2015-04-30 19:43:08 +01:00
2015-04-29 03:47:15 +01:00
For example:
```bash
export THEFUCK_RULES='sudo:no_command'
2015-09-06 10:55:59 +01:00
export THEFUCK_EXCLUDE_RULES='git_pull:git_push'
2015-04-29 03:47:15 +01:00
export THEFUCK_REQUIRE_CONFIRMATION='true'
export THEFUCK_WAIT_COMMAND=10
export THEFUCK_NO_COLORS='false'
2015-05-07 12:11:45 +01:00
export THEFUCK_PRIORITY='no_command=9999:apt_get=100'
2015-10-29 02:14:34 +00:00
export THEFUCK_HISTORY_LIMIT='2000'
2015-04-29 03:47:15 +01:00
```
2015-04-22 19:18:53 +01:00
2017-11-23 19:21:44 +00:00
## Third-party packages with rules
If you want to make very specific rules or rules, that you don't want to make public,
but share with other people.
You can create a special package with name `thefuck_contrib_*` with following structure:
```
thefuck_contrib_foo
thefuck_contrib_foo
rules
__init__ .py
*third-party rules*
__init__ .py
*third-party-utils*
setup.py
```
And thefuck will find all rules from `rules` module.
2017-08-26 12:31:09 +01:00
## Experimental instant mode
By default The Fuck reruns a previous command and that takes time,
in instant mode The Fuck logs output with [script ](https://en.wikipedia.org/wiki/Script_(Unix ))
and just reads the log.
2017-08-26 13:39:36 +01:00
[![gif with instant mode][instant-mode-gif-link]][instant-mode-gif-link]
2017-08-26 12:31:09 +01:00
At the moment only Python 3 with bash or zsh is supported.
For enabling instant mode you need to add `--enable-experimental-instant-mode`
to alias initialization in your `.bashrc` , `.bash_profile` or `.zshrc` like:
```bash
eval $(thefuck --alias --enable-experimental-instant-mode)
```
2015-04-08 17:15:49 +01:00
## Developing
Install `The Fuck` for development:
```bash
2015-04-17 15:24:03 +01:00
pip install -r requirements.txt
python setup.py develop
2015-04-08 17:15:49 +01:00
```
2016-10-06 20:37:12 +01:00
Run code style checks:
```bash
flake8
```
2015-07-24 01:56:21 +01:00
Run unit tests:
2015-04-08 17:15:49 +01:00
```bash
py.test
```
2015-04-17 20:51:13 +01:00
2015-07-24 01:56:21 +01:00
Run unit and functional tests (requires docker):
```bash
2015-09-05 23:13:44 +01:00
py.test --enable-functional
2015-07-24 01:56:21 +01:00
```
2015-07-27 20:23:20 +01:00
For sending package to pypi:
```bash
sudo apt-get install pandoc
./release.py
```
2015-04-17 20:51:13 +01:00
## License MIT
2015-04-20 15:32:50 +01:00
Project License can be found [here ](LICENSE.md ).
2016-04-01 01:48:22 +01:00
2016-04-01 01:58:14 +01:00
[version-badge]: https://img.shields.io/pypi/v/thefuck.svg?label=version
[version-link]: https://pypi.python.org/pypi/thefuck/
2017-04-20 20:34:47 +01:00
[travis-badge]: https://travis-ci.org/nvbn/thefuck.svg?branch=master
2016-04-01 01:48:22 +01:00
[travis-link]: https://travis-ci.org/nvbn/thefuck
2017-04-20 20:34:47 +01:00
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/1sskj4imj02um0gu/branch/master?svg=true
2016-04-01 01:48:22 +01:00
[appveyor-link]: https://ci.appveyor.com/project/nvbn/thefuck
2016-04-01 01:58:14 +01:00
[coverage-badge]: https://img.shields.io/coveralls/nvbn/thefuck.svg
[coverage-link]: https://coveralls.io/github/nvbn/thefuck
[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg
2016-04-01 01:48:22 +01:00
[examples-link]: https://raw.githubusercontent.com/nvbn/thefuck/master/example.gif
2017-08-28 02:39:17 +01:00
[instant-mode-gif-link]: https://raw.githubusercontent.com/nvbn/thefuck/master/example_instant_mode.gif
2016-05-04 02:50:14 +01:00
[homebrew]: http://brew.sh/