The user-friendly command line shell.
C++ Shell C Python JavaScript CSS Other
Pull request Compare This branch is 2310 commits behind fish-shell:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build_tools
doc_src
etc
fish.xcodeproj
osx
po
share
tests
.gitattributes
.gitignore
.travis.yml
CHANGELOG
CONTRIBUTING.md
Doxyfile
Doxyfile.help
Doxyfile.user
Makefile.in
README.md
autoload.cpp
autoload.h
builtin.cpp
builtin.h
builtin_commandline.cpp
builtin_complete.cpp
builtin_jobs.cpp
builtin_printf.cpp
builtin_set.cpp
builtin_set_color.cpp
builtin_test.cpp
builtin_ulimit.cpp
color.cpp
color.h
common.cpp
common.h
complete.cpp
complete.h
config.guess
config.sub
configure.ac
create_wajig_completions.py
env.cpp
env.h
env_universal.cpp
env_universal.h
env_universal_common.cpp
env_universal_common.h
event.cpp
event.h
exec.cpp
exec.h
expand.cpp
expand.h
fallback.cpp
fallback.h
fish.cpp
fish_indent.cpp
fish_tests.cpp
fishd.cpp
function.cpp
function.h
highlight.cpp
highlight.h
history.cpp
history.h
input.cpp
input.h
input_common.cpp
input_common.h
install-sh
intern.cpp
intern.h
io.cpp
io.h
iothread.cpp
iothread.h
key_reader.cpp
kill.cpp
kill.h
lru.h
mimedb.cpp
mimedb.h
output.cpp
output.h
pager.cpp
pager.h
parse_constants.h
parse_execution.cpp
parse_execution.h
parse_productions.cpp
parse_productions.h
parse_tree.cpp
parse_tree.h
parse_util.cpp
parse_util.h
parser.cpp
parser.h
parser_keywords.cpp
parser_keywords.h
path.cpp
path.h
postfork.cpp
postfork.h
print_help.cpp
print_help.h
proc.cpp
proc.h
reader.cpp
reader.h
release_notes.html
sanity.cpp
sanity.h
screen.cpp
screen.h
signal.cpp
signal.h
tokenizer.cpp
tokenizer.h
user_doc.head.html
utf8.cpp
utf8.h
util.cpp
util.h
wgetopt.cpp
wgetopt.h
wildcard.cpp
wildcard.h
wutil.cpp
wutil.h
xdgmime.cpp
xdgmime.h
xdgmimealias.cpp
xdgmimealias.h
xdgmimeglob.cpp
xdgmimeglob.h
xdgmimeint.cpp
xdgmimeint.h
xdgmimemagic.cpp
xdgmimemagic.h
xdgmimeparent.cpp
xdgmimeparent.h

README.md

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 http://fishshell.com/tutorial.html by searching for the magic phrase 'unlike other shells'.

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

Building

fish is written in a sane subset of C++98, with a few components from C++TR1. It builds successfully with g++ 4.2 or later, and with clang. It also will build as C++11.

fish can be built using autotools or Xcode. autoconf 2.60 or later is required.

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

fish requires gettext for translation support.

Building the documentation requires Doxygen 1.5 or newer.

Autotools Build

autoconf
./configure
make [gmake on BSD]
sudo make install

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 /

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 libncurses5-dev

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 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, which, and getopt. fish also requires the bc program.

Translation support requires the gettext program.

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. For Python versions 2.6 to 3.2 you need to install the module backports.lzma. How to install it depends on your system and how you installed Python. Most Linux distributions should include it as a package named backports-lzma (or similar). 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.

To switch your default shell back, you can run:

chsh -s /bin/bash

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

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 IRC channel #fish at irc.oftc.net.

Found a bug? Have an awesome idea? Please open an issue on this github page.