No description
Find a file
Kurtis Rader 96fca8b4ec fix how fish behaves when FISH_HISTORY is set
Without this change setting `FISH_HISTORY` causes interactive input to
no longer provide autosuggestions, completions, etc.

Fixes #4234
2017-07-27 21:32:49 -07:00
.github change the github issue template 2017-02-28 21:29:50 -08:00
build_tools improve detection of msgs to be translated 2017-06-02 17:52:55 -07:00
debian Upgrade git:// and http:// URLs to https:// 2017-02-17 21:31:44 +08:00
doc_src document need for double-quotes around test args 2017-07-25 17:04:41 -07:00
etc It's status --is-interactive (#3086) 2016-05-29 12:24:24 +02:00
fish.xcodeproj implement argparse --exclusive 2017-07-12 22:38:31 -07:00
m4 Enable C++11 in autotools build 2016-11-26 12:59:00 -08:00
osx Merge branch 'Integration_2.6.0' 2017-06-03 22:02:59 +08:00
pcre2-10.22 pcre2: add maintainer mode and disable by default 2017-01-18 16:44:48 -08:00
po replace __fish_urlencode with string escape 2017-06-23 22:46:36 -07:00
share modify prev commit to use builtin cd 2017-07-27 14:36:32 -07:00
src fix how fish behaves when FISH_HISTORY is set 2017-07-27 21:32:49 -07:00
tests fix argparse handling of short flag only specs 2017-07-21 15:55:52 -07:00
.clang-format config clang-format to ignore oclint pragmas 2016-05-04 18:08:26 -07:00
.cppcheck.rules remove pointless flock() lint warning 2017-05-09 21:03:00 -07:00
.cppcheck.suppressions lint: replace getpwuid() with getpwuid_r() 2017-05-10 21:08:36 -07:00
.editorconfig Add max_line_length to .editorconfig 2017-06-16 01:32:55 +02:00
.gitattributes .gitattributes: include build tools in exported archives 2017-05-16 20:22:06 +08:00
.gitignore Delete trailing spaces 2017-01-15 14:57:21 -08:00
.oclint fix oclint NPATH_COMPLEXITY custom threshold 2017-07-12 22:38:32 -07:00
.travis.yml travis: only run tests if make succeeds 2017-05-24 11:39:59 +08:00
CHANGELOG.md fix regression how fish_escape_delay_ms is handled 2017-07-19 19:09:55 -07:00
config.guess Update to latest config.sub and config.guess versions 2015-05-28 12:29:46 +08:00
config.sub Update to latest config.sub and config.guess versions 2015-05-28 12:29:46 +08:00
configure.ac lint: replace ctermid() with ctermid_r() 2017-05-09 21:39:25 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-07-02 12:56:43 +02:00
COPYING add flock fallback 2016-12-03 16:36:06 +08:00
Dockerfile math requires bc package 2015-01-22 14:47:28 +08:00
Doxyfile Delete trailing spaces 2017-01-15 14:57:21 -08:00
Doxyfile.help Silence the Makefile build 2016-07-31 12:24:35 -07:00
Doxyfile.user Silence the Makefile build 2016-07-31 12:24:35 -07:00
fish.pc.in Upgrade git:// and http:// URLs to https:// 2017-02-17 21:31:44 +08:00
fish.spec.in fish.spec.in: Remove which dependency 2017-04-08 13:25:26 +02:00
install-sh Update install-sh 2016-09-09 01:24:24 -07:00
lexicon_filter.in 'Correct' error to eror in lexicon_filter 2017-02-12 15:39:22 -08:00
Makefile.in implement argparse builtin 2017-07-12 22:38:24 -07:00
README.md Extract doc install into a separate target install-doc 2017-05-23 16:57:26 -07:00

fish - the friendly interactive shell Build Status

fish is a smart and user-friendly command line shell for OS X, 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

Building

fish requires a C++11 compiler. It builds successfully with g++ 4.8 or later, or with clang 3.3 or later.

fish can be built using autotools or Xcode. autoconf 2.60 or later, as well as automake 1.13 or later, are required to build from git versions. These are not required to build from released tarballs.

fish depends on a curses implementation, such as ncurses. The headers and libraries are required for building.

fish requires PCRE2 due to the regular expression support contained in the string builtin. A copy is included with the source code, and will be used automatically if it does not already exist on your system.

fish requires gettext for translation support.

Building the documentation requires Doxygen 1.8.7 or newer.

Autotools Build

autoreconf --no-recursive [if building from Git]
./configure
make [gmake on BSD]
sudo make install [sudo gmake install on BSD]

Xcode Development Build

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

Xcode Build and Install

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

Runtime Dependencies

fish requires a curses implementation, such as ncurses, to run.

fish requires PCRE2 due to the regular expression support contained in the string builtin. A bundled version will be compiled in automatically at build time if required.

fish requires a number of utilities to operate, which should be present on any Unix, GNU/Linux or OS X system. These include (but are not limited to) hostname, grep, awk, sed, and getopt. fish also requires the bc program.

Translation support requires the gettext program.

Usage output for builtin functions is generated on-demand from the installed manpages using nroff and ul.

Some optional features of fish, such as the manual page completion parser and the web configuration tool, require Python.

In order to generate completions from man pages compressed with either lzma or xz, you may need to install an extra Python package. Python versions prior to 2.6 are not supported. To process lzma-compresed manpages, backports.lzma is needed for Python 3.2 or older. From version 3.3 onwards, Python already includes the required module.

Packages for Linux

Instructions on how to find builds for several Linux distros are at https://github.com/fish-shell/fish-shell/wiki/Nightly-builds

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 to fish is in your /etc/shells file.

Use the following command if you didn't already add your fish path to /etc/shells.

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

To switch your default shell back, you can run:

chsh -s /bin/bash

Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate.

You may need to logout/login for the change (chsh) to take effect.

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 on this github page.