Metadata-Version: 2.4
Name: oopsh
Version: 1.1.0
Summary: Corrects your previous console command. A maintained fork of thefuck.
Author-email: Vladimir Iakovlev <nvbn.rm@gmail.com>
Maintainer: Giorgio Di Falco
License-Expression: MIT
Project-URL: Homepage, https://github.com/geomago/oopsh
Project-URL: Issues, https://github.com/geomago/oopsh/issues
Project-URL: Changelog, https://github.com/geomago/oopsh/blob/main/CHANGELOG.md
Keywords: shell,command-line,typo,thefuck,thefuck alternative,maintained fork,python 3.12
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Shells
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: colorama
Requires-Dist: decorator
Requires-Dist: psutil
Requires-Dist: pyte
Dynamic: license-file

# oopsh [![Version][version-badge]][version-link] [![Build Status][workflow-badge]][workflow-link] [![MIT License][license-badge]](https://github.com/geomago/oopsh/blob/main/LICENSE.md)

**oopsh** corrects errors in previous console commands: type `oops` after a
failed command and it suggests (and runs) the fixed one.

oopsh is a maintained fork of [thefuck](https://github.com/nvbn/thefuck) by
Vladimir Iakovlev, which is no longer maintained and doesn't run on Python 3.12+.
It is not an official thefuck release. All of thefuck's rules work in oopsh, and
the project keeps thefuck's full history and MIT license. See the
[roadmap](https://github.com/geomago/oopsh/blob/main/ROADMAP.md) for what's planned.

**Switching from thefuck?** Install oopsh and change one line in your shell config:
your settings, custom rules and `THEFUCK_*` variables keep working.
[More details](#coming-from-thefuck).

Is oopsh too slow? [Try the experimental instant mode!](#experimental-instant-mode)

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?

➜ oops
sudo apt-get install vim [enter/↑/↓/ctrl+c]
[sudo] password for nvbn:
Reading package lists... Done
...
```

```bash
➜ 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


➜ oops
git push --set-upstream origin master [enter/↑/↓/ctrl+c]
Counting objects: 9, done.
...
```

```bash
➜ 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

➜ oops
python [enter/↑/↓/ctrl+c]
Python 3.4.2 (default, Oct  8 2014, 13:08:17)
...
```

```bash
➜ git brnch
git: 'brnch' is not a git command. See 'git --help'.

Did you mean this?
    branch

➜ oops
git branch [enter/↑/↓/ctrl+c]
* master
```

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

Did you mean this?
         repl

➜ oops
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](#settings) option can be disabled:

```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?

➜ oops
sudo apt-get install vim
[sudo] password for nvbn:
Reading package lists... Done
...
```

## Contents

1. [Requirements](#requirements)
2. [Installation](#installation)
3. [Coming from thefuck](#coming-from-thefuck)
4. [Updating](#updating)
5. [How it works](#how-it-works)
6. [Creating your own rules](#creating-your-own-rules)
7. [Settings](#settings)
8. [Third party packages with rules](#third-party-packages-with-rules)
9. [Experimental instant mode](#experimental-instant-mode)
10. [Developing](#developing)
11. [License](#license-mit)

## Requirements

- Python 3.10+
- Linux, macOS or Windows; Bash, Zsh, Fish, PowerShell, tcsh or Nushell

##### [Back to Contents](#contents)

## Installation

Install oopsh with [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/),
which keep it in its own environment (recent Linux distributions don't let
`pip` install into the system Python):

```bash
pipx install oopsh
# or
uv tool install oopsh
```

On macOS and Linux you can also use [Homebrew](https://brew.sh/):

```bash
brew install geomago/tap/oopsh
```

<a href='#manual-installation' name='manual-installation'>#</a>
Then add this line to your `.bashrc`, `.zshrc` or other startup script:

```bash
eval "$(oopsh --alias)"
# You can use whatever you want as an alias:
eval "$(oopsh --alias argh)"
```

For other shells:

| Shell      | Config file      | Line to add                  |
|------------|------------------|------------------------------|
| Fish       | `~/.config/fish/config.fish` | `oopsh --alias \| source` |
| PowerShell | `$PROFILE`       | `iex "$(oopsh --alias)"`     |
| tcsh       | `~/.tcshrc`      | ``eval `oopsh --alias` ``    |

Nushell parses code before running it, so the alias goes to a file that nushell
loads after `config.nu`. Add this line to `config.nu` (`config nu` opens it):

```nu
mkdir ($nu.data-dir | path join vendor autoload); oopsh --alias | save -f (($nu.data-dir | path join vendor autoload) | path join oopsh.nu)
```

Nushell has no `eval`, so the fix runs in a subprocess (`sh`, or `nu` where
there's no `sh`). When the fix ends in another directory, like
`mkdir -p foo && cd foo`, the alias moves the shell there too; environment
variables set by a fix are lost.

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

If you just type `oops` before configuring anything, oopsh tells you which line
to add, and adds it for you if you run `oops` a second time.

The alias defines two shell functions: `oops` and `oopsh`, which do the same
thing. `oopsh` also stays the name of the program, so `oopsh --version`,
`oopsh --help` and `oopsh --alias` keep working. (In tcsh only `oops` is defined.)

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

```bash
oops --yeah
```

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

```bash
oops -r
```

##### [Back to Contents](#contents)

## Coming from thefuck

oopsh is a drop-in replacement for thefuck:

- Until you have an oopsh config dir, oopsh uses your thefuck one
  (`~/.config/thefuck/` or `~/.thefuck/`) as it is, settings and custom rules included.
- Custom rules and `thefuck_contrib_*` packages that import from thefuck
  (`from thefuck.utils import for_app`) keep working unchanged.
- `THEFUCK_*` environment variables keep working; the `OOPSH_*` ones win if both are set.

To switch:

1. In your shell config, replace `eval $(thefuck --alias)` with `eval "$(oopsh --alias)"`.
   You now type `oops` instead of `fuck`; to keep the old word, use `eval "$(oopsh --alias fuck)"`.
2. Optionally, run `oopsh --migrate`: it copies your thefuck config to `~/.config/oopsh/`
   (it never overwrites files) and tells you what else you may want to change.
3. Uninstall thefuck: `pip uninstall thefuck`.

##### [Back to Contents](#contents)

## Updating

```bash
pipx upgrade oopsh
# or
uv tool upgrade oopsh
# or
brew upgrade oopsh
```

## Uninstall

To remove oopsh, reverse the installation process:
- erase or comment the `oopsh --alias` line from your Bash, Zsh, Fish, PowerShell, tcsh, Nushell, ... shell config
- uninstall the package: `pipx uninstall oopsh` (or `uv tool uninstall oopsh`, or `brew uninstall oopsh`)

## How it works

oopsh 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` &ndash; fixes misspelled commands like `adb logcta`;
* `ag_literal` &ndash; adds `-Q` to `ag` when suggested;
* `aws_cli` &ndash; fixes misspelled commands like `aws dynamdb scan`;
* `az_cli` &ndash; fixes misspelled commands like `az providers`;
* `cargo` &ndash; runs `cargo build` instead of `cargo`;
* `cargo_no_command` &ndash; fixes wrong commands like `cargo buid`;
* `cat_dir` &ndash; replaces `cat` with `ls` when you try to `cat` a directory;
* `cd_correction` &ndash; spellchecks and corrects failed cd commands;
* `cd_cs` &ndash; changes `cs` to `cd`;
* `cd_mkdir` &ndash; creates directories before cd'ing into them;
* `cd_parent` &ndash; changes `cd..` to `cd ..`;
* `cd_quotes` &ndash; quotes directories with spaces, like `cd My Documents`;
* `chmod_x` &ndash; adds execution bit;
* `choco_install` &ndash; appends common suffixes for chocolatey packages;
* `composer_not_command` &ndash; fixes composer command name;
* `composer_not_package` &ndash; fixes misspelled package names for `composer require`, using composer's suggestions;
* `conda_mistype` &ndash; fixes conda commands;
* `cp_create_destination` &ndash; creates a new directory when you attempt to `cp` or `mv` to a non-existent one
* `cp_omitting_directory` &ndash; adds `-a` when you `cp` directory;
* `cpp11` &ndash; adds missing `-std=c++11` to `g++` or `clang++`;
* `dirty_untar` &ndash; fixes `tar x` command that untarred in the current directory;
* `dirty_unzip` &ndash; fixes `unzip` command that unzipped in the current directory;
* `django_south_ghost` &ndash; adds `--delete-ghost-migrations` to failed because ghosts django south migration;
* `django_south_merge` &ndash; adds `--merge` to inconsistent django south migration;
* `docker_login` &ndash; executes a `docker login` and repeats the previous command;
* `docker_not_command` &ndash; fixes wrong docker commands like `docker tags`;
* `docker_image_being_used_by_container` &dash; removes the container that is using the image before removing the image;
* `dry` &ndash; fixes repetitions like `git git push`;
* `edit_filename` &ndash; adds the missing extension when an editor is given a file that does not exist, like `vim module` to `vim module.py`;
* `fab_command_not_found` &ndash; fixes misspelled fabric commands;
* `fix_alt_space` &ndash; replaces Alt+Space with Space character;
* `fix_file` &ndash; opens a file with an error in your `$EDITOR`;
* `gcloud_cli` &ndash; fixes misspelled commands like `gcloud compute instance list`;
* `gem_unknown_command` &ndash; fixes wrong `gem` commands;
* `git_add` &ndash; fixes *"pathspec 'foo' did not match any file(s) known to git."*;
* `git_add_force` &ndash; adds `--force` to `git add <pathspec>...` when paths are .gitignore'd;
* `git_bisect_usage` &ndash; fixes `git bisect strt`, `git bisect goood`, `git bisect rset`, etc. when bisecting;
* `git_branch_delete` &ndash; changes `git branch -d` to `git branch -D`;
* `git_branch_delete_checked_out` &ndash; changes `git branch -d` to `git checkout master && git branch -D` when trying to delete a checked out branch;
* `git_branch_exists` &ndash; offers `git branch -d foo`, `git branch -D foo` or `git checkout foo` when creating a branch that already exists;
* `git_branch_list` &ndash; catches `git branch list` in place of `git branch` and removes created branch;
* `git_branch_0flag` &ndash; fixes commands such as `git branch 0v` and `git branch 0r` removing the created branch;
* `git_checkout` &ndash; fixes branch name or creates new branch;
* `git_clone_git_clone` &ndash; replaces `git clone git clone ...` with `git clone ...`
* `git_clone_missing` &ndash; adds `git clone` to URLs that appear to link to a git repository.
* `git_commit_add` &ndash; offers `git commit -a ...` or `git commit -p ...` after previous commit if it failed because nothing was staged;
* `git_commit_amend` &ndash; offers `git commit --amend` after previous commit;
* `git_commit_reset` &ndash; offers `git reset HEAD~` after previous commit;
* `git_diff_no_index` &ndash; adds `--no-index` to previous `git diff` on untracked files;
* `git_diff_staged` &ndash; adds `--staged` to previous `git diff` with unexpected output;
* `git_fix_stash` &ndash; fixes `git stash` commands (misspelled subcommand and missing `save`);
* `git_flag_after_filename` &ndash; fixes `fatal: bad flag '...' after filename`
* `git_help_aliased` &ndash; fixes `git help <alias>` commands replacing <alias> with the aliased command;
* `git_hook_bypass` &ndash; adds `--no-verify` flag previous to `git am`, `git commit`, or `git push` command;
* `git_lfs_mistype` &ndash; fixes mistyped `git lfs <command>` commands;
* `git_main_master` &ndash; fixes incorrect branch name between `main` and `master`
* `git_merge` &ndash; adds remote to branch names;
* `git_merge_unrelated` &ndash; adds `--allow-unrelated-histories` when required
* `git_not_command` &ndash; fixes wrong git commands like `git brnch`;
* `git_pull` &ndash; sets upstream before executing previous `git pull`;
* `git_pull_clone` &ndash; clones instead of pulling when the repo does not exist;
* `git_pull_uncommitted_changes` &ndash; stashes changes before pulling and pops them afterwards;
* `git_push` &ndash; adds `--set-upstream origin $branch` to previous failed `git push`;
* `git_push_different_branch_names` &ndash; fixes pushes when local branch name does not match remote branch name;
* `git_push_pull` &ndash; runs `git pull` when `push` was rejected;
* `git_push_without_commits` &ndash; creates an initial commit if you forget and only `git add .`, when setting up a new project;
* `git_rebase_no_changes` &ndash; runs `git rebase --skip` instead of `git rebase --continue` when there are no changes;
* `git_remote_delete` &ndash; replaces `git remote delete remote_name` with `git remote remove remote_name`;
* `git_rm_local_modifications` &ndash; adds `-f` or `--cached` when you try to `rm` a locally modified file;
* `git_rm_recursive` &ndash; adds `-r` when you try to `rm` a directory;
* `git_rm_staged` &ndash;  adds `-f` or `--cached` when you try to `rm` a file with staged changes
* `git_rebase_merge_dir` &ndash; offers `git rebase (--continue | --abort | --skip)` or removing the `.git/rebase-merge` dir when a rebase is in progress;
* `git_remote_seturl_add` &ndash; runs `git remote add` when `git remote set_url` on nonexistent remote;
* `git_safe_directory` &ndash; trusts a repository owned by another user with the `git config --global --add safe.directory` command git suggests;
* `git_stash` &ndash; stashes your local modifications before rebasing or switching branch;
* `git_stash_pop` &ndash; adds your local modifications before popping stash, then resets;
* `git_tag_force` &ndash; adds `--force` to `git tag <tagname>` when the tag already exists;
* `git_two_dashes` &ndash; adds a missing dash to commands like `git commit -amend` or `git rebase -continue`;
* `go_run` &ndash; appends `.go` extension when compiling/running Go programs;
* `go_unknown_command` &ndash; fixes wrong `go` commands, for example `go bulid`;
* `gradle_no_task` &ndash; fixes not found or ambiguous `gradle` task;
* `gradle_wrapper` &ndash; replaces `gradle` with `./gradlew`;
* `grep_arguments_order` &ndash; fixes `grep` arguments order for situations like `grep -lir . test`;
* `grep_recursive` &ndash; adds `-r` when you try to `grep` directory;
* `grunt_task_not_found` &ndash; fixes misspelled `grunt` commands;
* `gulp_not_task` &ndash; fixes misspelled `gulp` tasks;
* `has_exists_script` &ndash; prepends `./` when script/binary exists;
* `heroku_multiple_apps` &ndash; adds `--app <app>` to `heroku` commands like `heroku pg`;
* `heroku_not_command` &ndash; fixes wrong `heroku` commands like `heroku log`;
* `history` &ndash; tries to replace command with the most similar command from history;
* `hostscli` &ndash; tries to fix `hostscli` usage;
* `ifconfig_device_not_found` &ndash; fixes wrong device names like `wlan0` to `wlp2s0`;
* `java` &ndash; removes `.java` extension when running Java programs;
* `javac` &ndash; appends missing `.java` when compiling Java files;
* `kedro_no_such_command` &ndash; fixes wrong `kedro` commands like `kedro ne`;
* `lein_not_task` &ndash; fixes wrong `lein` tasks like `lein rpl`;
* `long_form_help` &ndash; changes `-h` to `--help` when the short form version is not supported
* `ln_no_hard_link` &ndash; catches hard link creation on directories, suggest symbolic link;
* `ln_s_order` &ndash; fixes `ln -s` arguments order;
* `ls_all` &ndash; adds `-A` to `ls` when output is empty;
* `ls_lah` &ndash; adds `-lah` to `ls`;
* `makefile` &ndash; fixes wrong `make` commands;
* `man` &ndash; changes manual section;
* `man_no_space` &ndash; fixes man commands without spaces, for example `mandiff`;
* `mercurial` &ndash; fixes wrong `hg` commands;
* `missing_space_before_subcommand` &ndash; fixes command with missing space like `npminstall`;
* `mkdir_p` &ndash; adds `-p` when you try to create a directory without a parent;
* `mvn_no_command` &ndash; adds `clean package` to `mvn`;
* `mvn_unknown_lifecycle_phase` &ndash; fixes misspelled life cycle phases with `mvn`;
* `ninja` &ndash; fixes wrong targets passed to the `ninja` build tool;
* `npm_missing_script` &ndash; fixes `npm` custom script name in `npm run-script <script>`;
* `npm_run_script` &ndash; adds missing `run-script` for custom `npm` scripts;
* `npm_wrong_command` &ndash; fixes wrong npm commands like `npm urgrade`;
* `no_command` &ndash; fixes wrong console commands, for example `vom/vim`;
* `no_such_file` &ndash; creates missing directories with `mv` and `cp` commands;
* `omnienv_no_such_command` &ndash; fixes wrong commands for `goenv`, `nodenv`, `pyenv` and `rbenv` (eg.: `pyenv isntall` or `goenv list`);
* `open` &ndash; either prepends `http://` to address passed to `open` or creates a new file or directory and passes it to `open`;
* `ping` &ndash; removes `http(s)://` and paths when you ping a URL copied from the browser;
* `pip_install` &ndash; fixes permission issues with `pip install` commands by adding `--user` or prepending `sudo` if necessary;
* `pip_unknown_command` &ndash; fixes wrong `pip` commands, for example `pip instatl/pip install`;
* `php_s` &ndash; replaces `-s` by `-S` when trying to run a local php server;
* `port_already_in_use` &ndash; kills process that bound port;
* `prove_recursively` &ndash; adds `-r` when called with directory;
* `python_command` &ndash; prepends `python` when you try to run non-executable/without `./` python script;
* `python_execute` &ndash; appends missing `.py` when executing Python files;
* `python_module_error` &ndash; fixes ModuleNotFoundError by trying to `pip install` that module;
* `quotation_marks` &ndash; fixes uneven usage of `'` and `"` when containing args';
* `path_from_history` &ndash; replaces not found path with a similar absolute path from history;
* `rails_migrations_pending` &ndash; runs pending migrations;
* `rbenv_install` &ndash; fixes ruby-build definition not found by updating ruby-build;
* `react_native_command_unrecognized` &ndash; fixes unrecognized `react-native` commands;
* `remove_shell_prompt_literal` &ndash; removes leading shell prompt symbol `$`, common when copying commands from documentations;
* `remove_trailing_cedilla` &ndash; removes trailing cedillas `ç`, a common typo for European keyboard layouts;
* `restic_typo` &ndash; fixes misspelled `restic` commands, like `restic snapshot`;
* `rm_dir` &ndash; adds `-rf` when you try to remove a directory;
* `scm_correction` &ndash; corrects wrong scm like `hg log` to `git log`;
* `sed_unterminated_s` &ndash; adds missing '/' to `sed`'s `s` commands;
* `sl_ls` &ndash; changes `sl` to `ls`;
* `ssh_known_hosts` &ndash; removes host from `known_hosts` on warning;
* `su` &ndash; runs the command with `su -c` when `sudo` is not installed;
* `sudo` &ndash; prepends `sudo` to the previous command if it failed because of permissions;
* `sudo_command_from_user_path` &ndash; runs commands from users `$PATH` with `sudo`;
* `switch_lang` &ndash; switches command from your local layout to en;
* `systemctl` &ndash; correctly orders parameters of confusing `systemctl`;
* `terraform_init.py` &ndash; runs `terraform init` before plan or apply;
* `terraform_init_upgrade` &ndash; runs `terraform init -upgrade` when the dependency lock file is out of date, then the command again;
* `terraform_no_command.py` &ndash; fixes unrecognized `terraform` commands;
* `test.py` &ndash; runs `pytest` instead of `test.py`;
* `touch` &ndash; creates missing directories before "touching";
* `tsuru_login` &ndash; runs `tsuru login` if not authenticated or session expired;
* `tsuru_not_command` &ndash; fixes wrong `tsuru` commands like `tsuru shell`;
* `tmux` &ndash; fixes `tmux` commands;
* `unknown_command` &ndash; fixes hadoop hdfs-style "unknown command", for example adds missing '-' to the command on `hdfs dfs ls`;
* `unsudo` &ndash; removes `sudo` from previous command if a process refuses to run on superuser privilege.
* `upper_to_lower_case` &ndash; replaces the uppercase letters with lowercase, so the command is correct;
* `vagrant_up` &ndash; starts up the vagrant instance;
* `whois` &ndash; fixes `whois` command;
* `workon_doesnt_exists` &ndash; fixes `virtualenvwrapper` env name os suggests to create new.
* `wrong_hyphen_before_subcommand` &ndash; removes an improperly placed hyphen (`apt-install` -> `apt install`, `git-log` -> `git log`, etc.)
* `yarn_alias` &ndash; fixes aliased `yarn` commands like `yarn ls`;
* `yarn_command_not_found` &ndash; fixes misspelled `yarn` commands;
* `yarn_command_replaced` &ndash; fixes replaced `yarn` commands;
* `yarn_help` &ndash; makes it easier to open `yarn` documentation;

##### [Back to Contents](#contents)

The following rules are enabled by default on specific platforms only:

* `apt_get` &ndash; installs app from apt if it not installed (requires `python-commandnotfound` / `python3-commandnotfound`);
* `apt_get_search` &ndash; changes trying to search using `apt-get` with searching using `apt-cache`;
* `apt_invalid_operation` &ndash; fixes invalid `apt` and `apt-get` calls, like `apt-get isntall vim`;
* `apt_list_upgradable` &ndash; helps you run `apt list --upgradable` after `apt update`;
* `apt_unable_to_locate` &ndash; suggests packages with a similar name when `apt` or `apt-get` cannot find a package;
* `apt_upgrade` &ndash; helps you run `apt upgrade` after `apt list --upgradable`;
* `brew_cask_dependency` &ndash; installs cask dependencies;
* `brew_install` &ndash; fixes formula name for `brew install`;
* `brew_reinstall` &ndash; turns `brew install <formula>` into `brew reinstall <formula>`;
* `brew_link` &ndash; adds `--overwrite --dry-run` if linking fails;
* `brew_uninstall` &ndash; adds `--force` to `brew uninstall` if multiple versions were installed;
* `brew_unknown_command` &ndash; fixes wrong brew commands, for example `brew docto/brew doctor`;
* `brew_update_formula` &ndash; turns `brew update <formula>` into `brew upgrade <formula>`;
* `dnf_no_such_command` &ndash; fixes mistyped DNF commands;
* `docker_daemon_not_running` &ndash; starts the Docker daemon with `systemctl` and runs the command again;
* `nix_shell` &ndash; runs a missing command in a `nix-shell` with the package that provides it;
* `nixos_cmd_not_found` &ndash; installs apps on NixOS;
* `pacman` &ndash; installs app with `pacman` if it is not installed (uses `yay`, `pikaur`, `yaourt` or `paru` if available);
* `pacman_invalid_option` &ndash; replaces lowercase `pacman` options with uppercase.
* `pacman_not_found` &ndash; fixes package name with `pacman`, `yay`, `pikaur`, `yaourt` or `paru`.
* `xcode_license` &ndash; accepts the Xcode license with `sudo xcodebuild -license` and runs the command again;
* `yum_invalid_operation` &ndash; fixes invalid `yum` calls, like `yum isntall vim`;

The following commands are bundled with oopsh, but are not enabled by
default:

* `git_push_force` &ndash; adds `--force-with-lease` to a `git push` (may conflict with `git_push_pull`);
* `rm_root` &ndash; adds `--no-preserve-root` to `rm -rf /` command.

##### [Back to Contents](#contents)

## Creating your own rules

To add your own rule, create a file named `your-rule-name.py`
in `~/.config/oopsh/rules`. The rule file must contain two functions:

```python
match(command: Command) -> bool
get_new_command(command: Command) -> str | list[str]
```

Additionally, rules can contain optional functions:

```python
side_effect(old_command: Command, fixed_command: str) -> None
```
Rules can also contain the optional variables `enabled_by_default`, `requires_output` and `priority`.

`Command` has three attributes: `script`, `output` and `script_parts`.
Your rule should not change `Command`.


**Rules api changed in 3.0:** To access a rule's settings, import it with
 `from oopsh.conf import settings`

`settings` is a special object assembled from `~/.config/oopsh/settings.py`,
and values from env ([see more below](#settings)).

A simple example rule for running a script with `sudo`:

```python
def match(command):
    return ('permission denied' in command.output.lower()
            or 'EACCES' in command.output)


def get_new_command(command):
    return 'sudo {}'.format(command.script)

# Optional:
enabled_by_default = True

def side_effect(command, fixed_command):
    subprocess.call('chmod 777 .', shell=True)

priority = 1000  # Lower first, default is 1000

requires_output = True
```

[More examples of rules](https://github.com/geomago/oopsh/tree/main/oopsh/rules),
[utility functions for rules](https://github.com/geomago/oopsh/tree/main/oopsh/utils.py),
[app/os-specific helpers](https://github.com/geomago/oopsh/tree/main/oopsh/specific/).

##### [Back to Contents](#contents)

## Settings

Several oopsh parameters can be changed in the file `$XDG_CONFIG_HOME/oopsh/settings.py`
(`$XDG_CONFIG_HOME` defaults to `~/.config`):

* `rules` &ndash; list of enabled rules, by default `oopsh.const.DEFAULT_RULES`;
* `exclude_rules` &ndash; list of disabled rules, by default `[]`;
* `require_confirmation` &ndash; requires confirmation before running new command, by default `True`;
* `wait_command` &ndash; the max amount of time in seconds for getting previous command output;
* `no_colors` &ndash; disable colored output;
* `priority` &ndash; dict with rules priorities, rule with lower `priority` will be matched first;
* `debug` &ndash; enables debug output, by default `False`;
* `history_limit` &ndash; the numeric value of how many history commands will be scanned, like `2000`;
* `alter_history` &ndash; push fixed command to history, by default `True`;
* `wait_slow_command` &ndash; max amount of time in seconds for getting previous command output if it in `slow_commands` list;
* `slow_commands` &ndash; list of slow commands;
* `num_close_matches` &ndash; the maximum number of close matches to suggest, by default `3`.
* `excluded_search_path_prefixes` &ndash; path prefixes to ignore when searching for commands, by default `[]`. On Windows Subsystem for Linux (WSL), adding `['/mnt/']` or `['/mnt/c/']` avoids searching Windows paths, which can make oopsh much slower.

An example of `settings.py`:

```python
rules = ['sudo', 'no_command']
exclude_rules = ['git_push']
require_confirmation = True
wait_command = 10
no_colors = False
priority = {'sudo': 100, 'no_command': 9999}
debug = False
history_limit = 9999
wait_slow_command = 20
slow_commands = ['react-native', 'gradle']
num_close_matches = 5
```

Or via environment variables:

* `OOPSH_RULES` &ndash; list of enabled rules, like `DEFAULT_RULES:rm_root` or `sudo:no_command`;
* `OOPSH_EXCLUDE_RULES` &ndash; list of disabled rules, like `git_pull:git_push`;
* `OOPSH_REQUIRE_CONFIRMATION` &ndash; require confirmation before running new command, `true/false`;
* `OOPSH_WAIT_COMMAND` &ndash; the max amount of time in seconds for getting previous command output;
* `OOPSH_NO_COLORS` &ndash; disable colored output, `true/false`;
* `OOPSH_PRIORITY` &ndash; priority of the rules, like `no_command=9999:apt_get=100`,
rule with lower `priority` will be matched first;
* `OOPSH_DEBUG` &ndash; enables debug output, `true/false`;
* `OOPSH_HISTORY_LIMIT` &ndash; how many history commands will be scanned, like `2000`;
* `OOPSH_ALTER_HISTORY` &ndash; push fixed command to history `true/false`;
* `OOPSH_WAIT_SLOW_COMMAND` &ndash; the max amount of time in seconds for getting previous command output if it in `slow_commands` list;
* `OOPSH_SLOW_COMMANDS` &ndash; list of slow commands, like `lein:gradle`;
* `OOPSH_NUM_CLOSE_MATCHES` &ndash; the maximum number of close matches to suggest, like `5`.
* `OOPSH_EXCLUDED_SEARCH_PATH_PREFIXES` &ndash; path prefixes to ignore when searching for commands, by default `[]`.

For example:

```bash
export OOPSH_RULES='sudo:no_command'
export OOPSH_EXCLUDE_RULES='git_pull:git_push'
export OOPSH_REQUIRE_CONFIRMATION='true'
export OOPSH_WAIT_COMMAND=10
export OOPSH_NO_COLORS='false'
export OOPSH_PRIORITY='no_command=9999:apt_get=100'
export OOPSH_HISTORY_LIMIT='2000'
export OOPSH_NUM_CLOSE_MATCHES='5'
```

##### [Back to Contents](#contents)

## Third-party packages with rules

If you'd like to make a specific set of non-public rules, but would still like
to share them with others, create a package named `oopsh_contrib_*` with
the following structure (packages named `thefuck_contrib_*` work too):

```
oopsh_contrib_foo
  oopsh_contrib_foo
    rules
      __init__.py
      *third-party rules*
    __init__.py
    *third-party-utils*
  pyproject.toml
```

oopsh will find rules located in the `rules` module.

##### [Back to Contents](#contents)

## Experimental instant mode

The default behavior of oopsh requires time to re-run previous commands.
When in instant mode, oopsh saves time by logging output with [script](https://en.wikipedia.org/wiki/Script_(Unix)),
then reading the log.

Currently, instant mode only supports bash or zsh. zsh's autocorrect function also needs to be disabled in order for oopsh to work properly.

To enable instant mode, add `--enable-experimental-instant-mode`
to the alias initialization in `.bashrc`, `.bash_profile` or `.zshrc`.

For example:

```bash
eval "$(oopsh --alias --enable-experimental-instant-mode)"
```

##### [Back to Contents](#contents)

## Developing

See [CONTRIBUTING.md](https://github.com/geomago/oopsh/blob/main/CONTRIBUTING.md)

## License MIT

Project License can be found [here](https://github.com/geomago/oopsh/blob/main/LICENSE.md).

oopsh is based on [thefuck](https://github.com/nvbn/thefuck) by Vladimir Iakovlev
and its many contributors, originally inspired by a
[@liamosaur](https://twitter.com/liamosaur/)
[tweet](https://twitter.com/liamosaur/status/506975850596536320).


[version-badge]:   https://img.shields.io/pypi/v/oopsh.svg?label=version
[version-link]:    https://pypi.org/project/oopsh/
[workflow-badge]:  https://github.com/geomago/oopsh/actions/workflows/test.yml/badge.svg
[workflow-link]:   https://github.com/geomago/oopsh/actions/workflows/test.yml
[license-badge]:   https://img.shields.io/badge/license-MIT-007EC7.svg

##### [Back to Contents](#contents)
