The user-friendly command line shell.
Clone or download
ridiculousfish Revert "Revert "Fix unsafe locale usage in `wcstod_l` fallback""
This reverts commit c15a702.

The tests are no longer broken after rerunning CMake.
Latest commit b1f5cb9 Jan 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add regression question to GitHub issue template Jan 11, 2019
build_tools pcre2: move to PCRE2 10.32 Dec 29, 2018
cmake Check for `-Werror=unguarded_availability` support before forcing it Jan 11, 2019
debian debian packaging: turn on tests in Debian packages Jan 10, 2019
doc_src docs: list full command to change default shell Jan 18, 2019
etc It's `status --is-interactive` (#3086) May 29, 2016
fish.xcodeproj pcre2: move to PCRE2 10.32 Dec 29, 2018
m4 Enable C++11 in autotools build Nov 26, 2016
osx Merge branch 'Integration_3.0.0' Dec 28, 2018
pcre2-10.32 pcre2: add maintainer mode and disable by default Dec 29, 2018
po Fix crash in `wait` in english Apr 10, 2018
share Fix completion of directories for configure Jan 17, 2019
src Revert "Revert "Fix unsafe locale usage in `wcstod_l` fallback"" Jan 19, 2019
tests Also set the read-only flag for non-electric vars Jan 18, 2019
.clang-format config clang-format to ignore oclint pragmas May 5, 2016
.cppcheck.rules remove pointless flock() lint warning May 10, 2017
.cppcheck.suppressions cppcheck: Suppress incorrectStringBooleanError Nov 14, 2018
.editorconfig Add max_line_length to .editorconfig Jun 15, 2017
.gitattributes pcre2: move to PCRE2 10.32 Dec 29, 2018
.gitignore Stop ignoring .out files in tests/ directory Apr 18, 2018
.oclint Tell `oclint` to ignore another idiom that is safe Sep 9, 2017
.travis.yml Remove bc from travis.yml Jan 13, 2019
BSDmakefile Fix accidental recursive invocation of `make` under BSD Jul 5, 2018
CHANGELOG.md Use mandoc when nroff not available Jan 8, 2019
CMakeLists.txt Fix cmake build Dec 30, 2018
CONTRIBUTING.md Change only to exactly Oct 6, 2018
COPYING add flock fallback Dec 3, 2016
Dockerfile Remove bc from Dockerfile Jan 13, 2019
Doxyfile Delete trailing spaces Jan 15, 2017
Doxyfile.help Silence the Makefile build Jul 31, 2016
Doxyfile.user Remove newlines from Doxyfile.user aliases Sep 16, 2018
Makefile.in Make autotools build use tinyexpr.cpp Dec 30, 2018
README.md README: update to reflect mandoc support Jan 8, 2019
config.guess Update to latest config.sub and config.guess versions May 28, 2015
config.sub Update to latest config.sub and config.guess versions May 28, 2015
config_cmake.h.in Fix `locale_t` under macOS 10.10 Jan 11, 2019
configure.ac autoconf: quiet warning by using AC_LANG_PROGRAM Jan 1, 2019
fish.pc.in Upgrade git:// and http:// URLs to https:// Feb 17, 2017
fish.spec.in fish.spec: run tests with SHOW_INTERACTIVE_LOG=1 Jan 11, 2019
install-sh Update install-sh Sep 9, 2016
lexicon_filter.in Document && and || Mar 5, 2018

README.md

fish - the friendly interactive shell Build Status

fish is a smart and user-friendly command line shell for macOS, Linux, and the rest of the family. fish includes features like syntax highlighting, autosuggest-as-you-type, and fancy tab completions that just work, with no configuration required.

For more on fish's design philosophy, see the design document.

Quick Start

fish generally works like other shells, like bash or zsh. A few important differences can be found at https://fishshell.com/docs/current/tutorial.html by searching for the magic phrase "unlike other shells".

Detailed user documentation is available by running help within fish, and also at https://fishshell.com/docs/current/index.html

You can quickly play with fish right in your browser by clicking the button below:

Try in browser

Getting fish

macOS

fish can be installed:

Packages for Linux

Packages for Debian, Fedora, openSUSE, and Red Hat Enterprise Linux/CentOS are available from the openSUSE Build Service.

Packages for Ubuntu are available from the fish PPA, and can be installed using the following commands:

sudo apt-add-repository ppa:fish-shell/release-3
sudo apt-get update
sudo apt-get install fish

Instructions for other distributions may be found at fishshell.com.

Windows

  • On Windows 10, fish can be installed under the WSL Windows Subsystem for Linux with sudo apt install fish or from source with the instructions below.
  • Fish can also be installed on all versions of Windows using Cygwin (from the Shells category).

Building from source

If packages are not available for your platform, GPG-signed tarballs are available from fishshell.com and fish-shell on GitHub. See the Building section for instructions.

Running fish

Once installed, run fish from your current shell to try fish out!

Dependencies

Running fish requires:

  • curses or ncurses (preinstalled on most *nix systems)
  • some common *nix system utilities (currently mktemp and seq), in addition to the basic POSIX utilities
  • gettext (library and gettext command), if compiled with translation support

The following optional features also have specific requirements:

  • builtin commands that have the --help option or print usage messages require ul and either nroff or mandoc for display
  • automated completion generation from manual pages requires Python (2.7+ or 3.3+) and possibly the backports.lzma module for Python 2.7
  • the fish_config web configuration tool requires Python (2.7+ or 3.3 +) and a web browser
  • system clipboard integration (with the default Ctrl-V and Ctrl-X bindings) require either the xsel or pbcopy/pbpaste utilities
  • full completions for yarn and bower require the jq utility
  • full completions for yarn and npm require the all-the-package-names NPM module

Switching to fish

If you wish to use fish as your default shell, use the following command:

chsh -s /usr/local/bin/fish

chsh will prompt you for your password and change your default shell. (Substitute /usr/local/bin/fish with whatever path fish was installed to, if it differs.)

Use the following command if fish isn't already added to /etc/shells to permit fish to be your login shell:

echo /usr/local/bin/fish | sudo tee -a /etc/shells

To switch your default shell back, you can run chsh -s /bin/bash (substituting /bin/bash with /bin/tcsh or /bin/zsh as appropriate).

Building

Dependencies

Compiling fish requires:

  • a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later)
  • any of CMake, GNU Make, or (on macOS only) Xcode
  • a curses implementation such as ncurses (headers and libraries)
  • PCRE2 (headers and libraries) - a copy is included with fish
  • gettext (headers and libraries) - optional, for translation support

Additionally, if compiling fish with GNU Make from git (that is, not from an officially released tarball), autoconf 2.60+ and automake 1.13+ are required. Doxygen (1.8.7 or later) is also optionally required to build the documentation from a cloned git repository.

Building from source (all platforms)

Using CMake (preferred)

mkdir build; cd build
cmake ..
make
sudo make install

Using autotools

autoreconf --no-recursive #if building from Git
./configure
make
sudo make install

Building from source (macOS only)

  • Build the base target in Xcode
  • Run the fish executable, for example, in DerivedData/fish/Build/Products/Debug/base/bin/fish

To build and install fish with Xcode on macOS, execute the following in a terminal:

xcodebuild install
sudo ditto /tmp/fish.dst /
sudo make install-doc

Help, it didn't build!

If fish reports that it could not find curses, try installing a curses development package and build again.

On Debian or Ubuntu you want:

sudo apt-get install build-essential ncurses-dev libncurses5-dev gettext autoconf

On RedHat, CentOS, or Amazon EC2:

sudo yum install ncurses-devel

Contributing Changes to the Code

See the Guide for Developers.

Contact Us

Questions, comments, rants and raves can be posted to the official fish mailing list at https://lists.sourceforge.net/lists/listinfo/fish-users or join us on our gitter.im channel or IRC channel #fish at irc.oftc.net. Or use the fish tag on Stackoverflow for questions related to fish script and the fish tag on Superuser for all other questions (e.g., customizing colors, changing key bindings).

Found a bug? Have an awesome idea? Please open an issue.