- Notifications
You must be signed in to change notification settings - Fork2.1k
The user-friendly command line shell.
License
fish-shell/fish-shell
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
fish - the friendly interactive shell

fish is a smart and user-friendly command line shell for macOS, Linux,and the rest of the family. fish includes features like syntaxhighlighting, autosuggest-as-you-type, and fancy tab completions thatjust work, with no configuration required.
For downloads, screenshots and more, go tohttps://fishshell.com/.
fish generally works like other shells, like bash or zsh. A fewimportant differences can be found athttps://fishshell.com/docs/current/tutorial.html by searching for themagic phrase “unlike other shells”.
Detailed user documentation is available by runninghelp
withinfish, and also athttps://fishshell.com/docs/current/index.html
fish can be installed:
- usingHomebrew:
brew install fish
- usingMacPorts:
sudo port install fish
- using theinstaller from fishshell.com
- as astandalone app from fishshell.com
Note: The minimum supported macOS version is 10.10 "Yosemite".
Packages for Debian, Fedora, openSUSE, and Red Hat EnterpriseLinux/CentOS are available from theopenSUSE BuildService.
Packages for Ubuntu are available from thefishPPA,and can be installed using the following commands:
sudo apt-add-repository ppa:fish-shell/release-4sudo apt updatesudo apt install fish
Instructions for other distributions may be found atfishshell.com.
- On Windows 10/11, fish can be installed under the WSL Windows Subsystemfor Linux with the instructions for the appropriate distributionlisted above under “Packages for Linux”, or from source with theinstructions below.
- fish (4.0 on and onwards) cannot be installed in Cygwin, due to a lack of Rust support.
If packages are not available for your platform, GPG-signed tarballs areavailable fromfishshell.com andfish-shell onGitHub. See theBuilding section for instructions.
Once installed, runfish
from your current shell to try fish out!
Running fish requires:
- some common *nix system utilities (currently
mktemp
), inaddition to the basic POSIX utilities (cat
,cut
,dirname
,file
,ls
,mkdir
,mkfifo
,rm
,sort
,tee
,tr
,uname
andsed
at least, but the full coreutils plusfind
andawk
is preferred) - The gettext library, if compiled withtranslation support
The following optional features also have specific requirements:
- builtin commands that have the
--help
option or print usagemessages requirenroff
ormandoc
fordisplay - automated completion generation from manual pages requires Python 3.5+
- the
fish_config
web configuration tool requires Python 3.5+ and a web browser - system clipboard integration (with the default Ctrl-V and Ctrl-Xbindings) require either the
xsel
,xclip
,wl-copy
/wl-paste
orpbcopy
/pbpaste
utilities - full completions for
yarn
andnpm
require theall-the-package-names
NPM module colorls
is used, if installed, to add color when runningls
on platformsthat do not have color support (such as OpenBSD)
Compiling fish requires:
- Rust (version 1.70 or later)
- CMake (version 3.15 or later)
- a C compiler (for system feature detection and the test helper binary)
- PCRE2 (headers and libraries) - optional, this will be downloaded if missing
- gettext (headers and libraries) - optional, for translation support
- an Internet connection, as other dependencies will be downloaded automatically
Sphinx is also optionally required to build the documentation from acloned git repository.
Additionally, running the full test suite requires Python 3, tmux, and the pexpect package.
Rather than building from source, consider using a packaged build for your platform. Using thesteps below makes fish difficult to uninstall or upgrade. Release packages are available from thelinks above, and up-to-datedevelopment builds of fish are available for many platforms
To install into/usr/local
, run:
mkdir build;cd buildcmake ..cmake --build.sudo cmake --install.
The install directory can be changed using the-DCMAKE_INSTALL_PREFIX
parameter forcmake
.
In addition to the normal CMake build options (likeCMAKE_INSTALL_PREFIX
), fish's CMake build has some other options available to customize it.
- Rust_COMPILER=path - the path to rustc. If not set, cmake will check $PATH and ~/.cargo/bin
- Rust_CARGO=path - the path to cargo. If not set, cmake will check $PATH and ~/.cargo/bin
- Rust_CARGO_TARGET=target - the target to pass to cargo. Set this for cross-compilation.
- BUILD_DOCS=ON|OFF - whether to build the documentation. This is automatically set to OFF when Sphinx isn't installed.
- INSTALL_DOCS=ON|OFF - whether to install the docs. This is automatically set to on when BUILD_DOCS is or prebuilt documentation is available (like when building in-tree from a tarball).
- FISH_USE_SYSTEM_PCRE2=ON|OFF - whether to use an installed pcre2. This is normally autodetected.
- MAC_CODESIGN_ID=String|OFF - the codesign ID to use on Mac, or "OFF" to disable codesigning.
- WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations.
- extra_functionsdir, extra_completionsdir and extra_confdir - to compile in an additional directory to be searched for functions, completions and configuration snippets
You can also build fish with the data files embedded.
This will include all the datafiles like the included functions or web configuration tool in the mainfish
binary.
Fish will then read these right from its own binary, and print them out when needed. Some files, like the webconfig tool and the manpage completion generator, will be extracted to a temporary directory on-demand. You can list the files withstatus list-files
and print one withstatus get-file path/to/file
(e.g.status get-file functions/fish_prompt.fish
to get the default prompt).
To install fish with embedded files, just usecargo
, like:
cargo install --path /path/to/fish # if you have a git clonecargo install --git https://github.com/fish-shell/fish-shell --tag 4.0.0 # to build from git with a specific versioncargo install --git https://github.com/fish-shell/fish-shell # to build the current development snapshot without cloning
This will place the binaries in~/.cargo/bin/
, but you can place them wherever you want.
This build won't have the HTML docs (help
will open the online version) or translations.
It will try to build the man pages with sphinx-build. If that is not available and you would like to include man pages, you need to install it and retrigger the build script, e.g. by setting FISH_BUILD_DOCS=1:
FISH_BUILD_DOCS=1 cargo install --path .
Setting it to "0" disables the inclusion of man pages.
You can also link this build statically (but not against glibc) and move it to other computers.
See theGuide for Developers.
Questions, comments, rants and raves can be posted to the official fishmailing list athttps://lists.sourceforge.net/lists/listinfo/fish-usersor join us on ourmatrixchannel. Or use thefish tagon Unix & Linux Stackexchange.There is also a fish tag on Stackoverflow, but it is typically a poor fit.
Found a bug? Have an awesome idea? Pleaseopen anissue.
About
The user-friendly command line shell.
Topics
Resources
License
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.