Skip to content
The user-friendly command line shell.
Shell C++ Python CMake JavaScript HTML Other
Branch: master
Clone or download

Latest commit

ammgws kdeconnect-cli completions: ignore stderror (#7074)
* kdeconnect-cli completions: ignore error messages

* squash this please
Latest commit 4dff15b Jun 3, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.builds CI: Add python dependencies Jun 25, 2019
.github Update some .md references May 30, 2020
benchmarks Reindent functions to remove useless quotes Mar 9, 2020
build_tools Update littlecheck May 16, 2020
cmake Update some .md references May 30, 2020
debian debian packaging: change README.md to README.rst May 31, 2020
doc_src docs: Mention that reloading can take a bit May 30, 2020
etc Update /etc/config.fish to use current syntax May 8, 2020
osx Add the get-task-allow entitlement Feb 29, 2020
pcre2 pcre2: re-import some sources overzealously removed in 73ecf15 May 12, 2020
po Purge remnants of process expansion, document {fish,last}_pid May 16, 2020
share kdeconnect-cli completions: ignore stderror (#7074) Jun 3, 2020
src Add "alacritty" to the list of known titleable TERMs Jun 2, 2020
tests set: Show pathvariableness in --show Jun 1, 2020
.clang-format Ensure that clang-format places config.h first in header list Oct 13, 2019
.clang-tidy [clang-tidy] remove pointless public Apr 5, 2020
.cppcheck.rules remove pointless flock() lint warning May 10, 2017
.cppcheck.suppressions cppcheck: Suppress incorrectStringBooleanError Nov 14, 2018
.editorconfig Don't trim trailing whitespace on .rst files Jun 16, 2019
.gitattributes We no longer have two doc systems, move sphinx_doc_src back to doc_src Feb 20, 2020
.gitignore gitignore __pycache__ Mar 22, 2020
.oclint Tell `oclint` to ignore another idiom that is safe Sep 9, 2017
.travis.yml Travis: PCRE2 is already installed on osx May 11, 2020
BSDmakefile Revert "Remove Makefile(s)" Dec 19, 2019
CHANGELOG.rst CHANGELOG: Fix formatting Jun 2, 2020
CMakeLists.txt Add clang-tidy to build_tools/lint.fish Apr 4, 2020
CONTRIBUTING.rst Update some .md references May 30, 2020
COPYING chore: bump copyright year 2019 → 2020 Mar 14, 2020
Dockerfile Update Dockerfile for cmake3 Apr 28, 2019
GNUmakefile [make] add default `all` in addition to catch-all `%` Dec 19, 2019
README.rst Update some .md references May 30, 2020
config_cmake.h.in Guard thread_local May 22, 2020
fish.desktop Add .desktop file and logo for appimage Jan 8, 2020
fish.pc.in Use pkg-config variables Apr 4, 2020
fish.png Add .desktop file and logo for appimage Jan 8, 2020
fish.spec.in Update some .md references May 30, 2020

README.rst

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 the instructions for the appropriate distribution listed above under “Packages for Linux”, 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), in addition to the basic POSIX utilities (cat, cut, dirname, ls, mkdir, mkfifo, rm, sort, tee, tr, uname and sed at least, but the full coreutils plus find, sed and awk is preferred)
  • 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, xclip, wl-copy/wl-paste or pbcopy/pbpaste utilities
  • 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.) Log out, then log in again for the changes to take effect.

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)
  • CMake (version 3.2 or later)
  • 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

Sphinx is also optionally required to build the documentation from a cloned git repository.

Building from source (all platforms) - Makefile generator

To install into /usr/local, run:

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

The install directory can be changed using the -DCMAKE_INSTALL_PREFIX parameter for cmake.

Building from source (macOS) - Xcode

mkdir build; cd build
cmake .. -G Xcode

An Xcode project will now be available in the build subdirectory. You can open it with Xcode, or run the following to build and install in /usr/local:

xcodebuild
xcodebuild -scheme install

The install directory can be changed using the -DCMAKE_INSTALL_PREFIX parameter for cmake.

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 cmake ncurses-dev libncurses5-dev libpcre2-dev gettext

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 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.

You can’t perform that action at this time.