The Fuck [![Version][version-badge]][version-link] [![Build Status][workflow-badge]][workflow-link] [![Coverage][coverage-badge]][coverage-link] ![MIT License][license-badge]

The Fuck is a magnificent app, inspired by a @liamosaur tweet, that corrects errors in previous console commands.

Is The Fuck too slow? Try the experimental instant mode!

[![gif with examples][examples-link]][examples-link]

More examples:

➜ 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 apt-get install vim [enter/↑/↓/ctrl+c]
[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
git push --set-upstream origin master [enter/↑/↓/ctrl+c]
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 [enter/↑/↓/ctrl+c]
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
git branch [enter/↑/↓/ctrl+c]
* master

➜ lein rpl
'rpl' is not a task. See 'lein help'.

Did you mean this?
         repl

➜ fuck
lein repl [enter/↑/↓/ctrl+c]
nREPL server started on port 54848 on host 127.0.0.1 - nrepl://127.0.0.1:54848
REPL-y 0.3.1
...

If you're not afraid of blindly running corrected commands, the require_confirmation settings option can be disabled:

➜ 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 apt-get install vim
[sudo] password for nvbn:
Reading package lists... Done
...

Contents

1. Requirements
2. Installations
3. Updating
4. How it works
5. Creating your own rules
6. Settings
7. Third party packages with rules
8. Experimental instant mode
9. Developing
10. License

Requirements

• python (3.4+)
• pip
• python-dev

Back to Contents

Installation

On macOS or Linux, you can install The Fuck via [Homebrew][homebrew]:

brew install thefuck

On Ubuntu / Mint, install The Fuck with the following commands:

sudo apt update
sudo apt install python3-dev python3-pip python3-setuptools
pip3 install thefuck --user

On FreeBSD, install The Fuck with the following commands:

pkg install thefuck

On ChromeOS, install The Fuck using chromebrew with the following command:

crew install thefuck

On other systems, install The Fuck by using pip:

pip install thefuck

Alternatively, you may use an OS package manager (OS X, Ubuntu, Arch).

# It is recommended that you place this command in your .bash_profile, .bashrc, .zshrc or other startup script:

eval $(thefuck --alias)
# You can use whatever you want as an alias, like for Mondays:
eval $(thefuck --alias FUCK)

Or in your shell config (Bash, Zsh, Fish, Powershell, tcsh).

Changes are only available in a new shell session. To make changes immediately available, run source ~/.bashrc (or your shell config file like .zshrc).

To run fixed commands without confirmation, use the --yeah option (or just -y for short, or --hard if you're especially frustrated):

fuck --yeah

To fix commands recursively until succeeding, use the -r option:

fuck -r

Back to Contents

Updating

pip3 install thefuck --upgrade

Note: Alias functionality was changed in v1.34 of The Fuck

Uninstall

To remove The Fuck, reverse the installation process: - erase or comment thefuck alias line from your Bash, Zsh, Fish, Powershell, tcsh, ... shell config - use your package manager (brew, pip3, pkg, crew, pip) to uninstall the binaries

How it works

The Fuck attempts to match the previous command with a rule. If a match is found, a new command is created using the matched rule and executed. The following rules are enabled by default:

• adb_unknown_command – fixes misspelled commands like adb logcta;
• ag_literal – adds -Q to ag when suggested;
• aws_cli – fixes misspelled commands like aws dynamdb scan;
• az_cli – fixes misspelled commands like az providers;
• cargo – runs cargo build instead of cargo;
• cargo_no_command – fixes wrongs commands like cargo buid;
• cat_dir – replaces cat with ls when you try to cat a directory;
• cd_correction – spellchecks and correct failed cd commands;
• cd_cs – changes cs to cd;
• cd_mkdir – creates directories before cd'ing into them;
• cd_parent – changes cd.. to cd ..;
• chmod_x – add execution bit;
• choco_install – append common suffixes for chocolatey packages;
• composer_not_command – fixes composer command name;
• conda_mistype – fixes conda commands;
• cp_create_destination – creates a new directory when you attempt to cp or mv to a non existent one
• cp_omitting_directory – adds -a when you cp directory;
• cpp11 – adds missing -std=c++11 to g++ or clang++;
• dirty_untar – fixes tar x command that untarred in the current directory;
• dirty_unzip – fixes unzip command that unzipped in the current directory;
• django_south_ghost – adds --delete-ghost-migrations to failed because ghosts django south migration;
• django_south_merge – adds --merge to inconsistent django south migration;
• docker_login – executes a docker login and repeats the previous command;
• docker_not_command – fixes wrong docker commands like docker tags;
• docker_image_being_used_by_container ‐ removes the container that is using the image before removing the image;
• dry – fixes repetitions like git git push;
• fab_command_not_found – fix misspelled fabric commands;
• fix_alt_space – replaces Alt+Space with Space character;
• fix_file – opens a file with an error in your $EDITOR;
• gem_unknown_command – fixes wrong gem commands;
• git_add – fixes "pathspec 'foo' did not match any file(s) known to git.";
• git_add_force – adds --force to git add <pathspec>... when paths are .gitignore'd;
• git_bisect_usage – fixes git bisect strt, git bisect goood, git bisect rset, etc. when bisecting;
• git_branch_delete – changes git branch -d to git branch -D;
• git_branch_delete_checked_out – changes git branch -d to git checkout master && git branch -D when trying to delete a checked out branch;
• git_branch_exists – offers git branch -d foo, git branch -D foo or git checkout foo when creating a branch that already exists;
• git_branch_list – catches git branch list in place of git branch and removes created branch;
• git_branch_0flag – fixes commands such as git branch 0v and git branch 0r removing the created branch;
• git_checkout – fixes branch name or creates new branch;
• git_clone_git_clone – replaces git clone git clone ... with git clone ...
• git_commit_add – offers git commit -a ... or git commit -p ... after previous commit if it failed because nothing was staged;
• git_commit_amend – offers git commit --amend after previous commit;
• git_commit_reset – offers git reset HEAD~ after previous commit;
• git_diff_no_index – adds --no-index to previous git diff on untracked files;
• git_diff_staged – adds --staged to previous git diff with unexpected output;
• git_fix_stash – fixes git stash commands (misspelled subcommand and missing save);
• git_flag_after_filename – fixes fatal: bad flag '...' after filename
• git_help_aliased – fixes git help <alias> commands replacing with the aliased command;
• git_hook_bypass – adds --no-verify flag previous to git am, git commit, or git push command;
• git_lfs_mistype – fixes mistyped git lfs <command> commands;
• git_main_master – fixes incorrect branch name between main and master
• git_merge – adds remote to branch names;
• git_merge_unrelated – adds --allow-unrelated-histories when required
• git_not_command – fixes wrong git commands like git brnch;
• git_pull – sets upstream before executing previous git pull;
• git_pull_clone – clones instead of pulling when the repo does not exist;
• git_pull_uncommitted_changes – stashes changes before pulling and pops them afterwards;
• git_push – adds --set-upstream origin $branch to previous failed git push;
• git_push_different_branch_names – fixes pushes when local branch name does not match remote branch name;
• git_push_pull – runs git pull when push was rejected;
• git_push_without_commits – Creates an initial commit if you forget and only git add ., when setting up a new project;
• git_rebase_no_changes – runs git rebase --skip instead of git rebase --continue when there are no changes;
• git_remote_delete – replaces git remote delete remote_name with git remote remove remote_name;
• git_rm_local_modifications – adds -f or --cached when you try to rm a locally modified file;
• git_rm_recursive – adds -r when you try to rm a directory;
• git_rm_staged – adds -f or --cached when you try to rm a file with staged changes
• git_rebase_merge_dir – offers git rebase (--continue | --abort | --skip) or removing the .git/rebase-merge dir when a rebase is in progress;
• git_remote_seturl_add – runs git remote add when git remote set_url on nonexistent remote;
• git_stash – stashes your local modifications before rebasing or switching branch;
• git_stash_pop – adds your local modifications before popping stash, then resets;
• git_tag_force – adds --force to git tag <tagname> when the tag already exists;
• git_two_dashes – adds a missing dash to commands like git commit -amend or git rebase -continue;
• go_run – appends .go extension when compiling/running Go programs;
• go_unknown_command – fixes wrong go commands, for example go bulid;
• gradle_no_task – fixes not found or ambiguous gradle task;
• gradle_wrapper – replaces gradle with ./gradlew;
• grep_arguments_order – fixes grep arguments order for situations like grep -lir . test;
• grep_recursive – adds -r when you try to grep directory;
• grunt_task_not_found – fixes misspelled grunt commands;
• gulp_not_task – fixes misspelled gulp tasks;
• has_exists_script – prepends ./ when script/binary exists;
• heroku_multiple_apps – add --app <app> to heroku commands like heroku pg;
• heroku_not_command – fixes wrong heroku commands like heroku log;
• history – tries to replace command with the most similar command from history;
• hostscli – tries to fix hostscli usage;
• ifconfig_device_not_found – fixes wrong device names like wlan0 to wlp2s0;
• java – removes .java extension when running Java programs;
• javac – appends missing .java when compiling Java files;
• lein_not_task – fixes wrong lein tasks like lein rpl;
• long_form_help – changes -h to --help when the short form version is not supported
• ln_no_hard_link – catches hard link creation on directories, suggest symbolic link;
• ln_s_order – fixes ln -s arguments order;
• ls_all – adds -A to ls when output is empty;
• ls_lah – adds -lah to ls;
• man – changes manual section;
• man_no_space – fixes man commands without spaces, for example mandiff;
• mercurial – fixes wrong hg commands;
• missing_space_before_subcommand – fixes command with missing space like npminstall;
• mkdir_p – adds -p when you try to create a directory without a parent;
• mvn_no_command – adds clean package to mvn;
• mvn_unknown_lifecycle_phase – fixes misspelled life cycle phases with mvn;
• npm_missing_script – fixes npm custom script name in npm run-script <script>;
• npm_run_script – adds missing run-script for custom npm scripts;
• npm_wrong_command – fixes wrong npm commands like npm urgrade;
• no_command – fixes wrong console commands, for example vom/vim;
• no_such_file – creates missing directories with mv and cp commands;
• omnienv_no_such_command – fixes wrong commands for goenv, nodenv, pyenv and rbenv (eg.: pyenv isntall or goenv list);
• open – either prepends http:// to address passed to open or create a new file or directory and passes it to open;
• `pip_install