The user-friendly command line shell.
Go to file
Konrad Borowski 2726712e01 Restore DejaVu Sans Condensed font.
With font-strentch: condensed, the rendering is acceptable.
2014-09-23 12:28:08 +02:00
build_tools Merge branch 'master' into documentation-update 2014-09-07 16:37:31 +01:00
doc_src Restore DejaVu Sans Condensed font. 2014-09-23 12:28:08 +02:00
etc
fish.xcodeproj Add wcstringutil to the OS X build for tests target 2014-09-21 23:35:19 -07:00
osx Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
po Merge branch 'master' into documentation-update 2014-09-07 16:37:31 +01:00
share Only print fish_greeting for interactive shells 2014-09-21 20:35:33 -07:00
tests Support wide characters in printf %c 2014-09-21 23:22:43 -07:00
.gitattributes Merge branch 'master' into documentation-update 2014-09-07 16:37:31 +01:00
.gitignore Rebase documentation changes 2014-09-03 15:10:53 +01:00
.travis.yml Dump interactive logs on travis test failure 2014-09-19 14:52:02 -07:00
autoload.cpp Use source instead of . in autoload.cpp. 2014-04-04 15:59:41 +02:00
autoload.h Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
builtin_commandline.cpp Make commandline -P actually work 2014-08-24 14:47:05 -07:00
builtin_complete.cpp Erase all completions with complete -c foo -e 2014-09-02 15:30:58 -07:00
builtin_jobs.cpp Fix indentation 2014-06-07 23:27:06 -07:00
builtin_printf.cpp Support wide characters in printf %c 2014-09-21 23:22:43 -07:00
builtin_set_color.cpp Further support for term24bit. Teach output.cpp what to do with it. 2014-09-19 18:45:04 -07:00
builtin_set.cpp set: Print an error when setting umask to a bad value 2014-08-21 19:06:21 -07:00
builtin_test.cpp Fix some warnings in Linux build 2014-05-31 13:46:28 -07:00
builtin_ulimit.cpp
builtin.cpp Support bind SEQ to print a binding for SEQ 2014-09-22 21:30:44 -07:00
builtin.h Support for command wrapping ("aliases") 2014-08-15 18:14:36 -07:00
CHANGELOG
color.cpp Initial work to support for term-24bit ("true color") 2014-09-19 18:45:04 -07:00
color.h Further support for term24bit. Teach output.cpp what to do with it. 2014-09-19 18:45:04 -07:00
common.cpp Rework how screen size is tracked 2014-08-29 12:46:03 -07:00
common.h Show -M and -m flags in bind list 2014-09-22 12:37:11 -07:00
complete.cpp Don't include child directories of $PATH in completions 2014-09-20 00:31:33 -07:00
complete.h Don't erase old-style options with complete -l foo -e 2014-09-02 15:30:58 -07:00
config.guess
config.sub
configure.ac Makefile/configure: detect and use sed from configure 2014-09-18 20:29:49 +08:00
CONTRIBUTING.md
create_wajig_completions.py
Doxyfile Remove CLANG options, for portability 2014-09-04 11:58:01 +01:00
Doxyfile.help Remove CLANG options, for portability 2014-09-04 11:58:01 +01:00
Doxyfile.user Remove CLANG options, for portability 2014-09-04 11:58:01 +01:00
env_universal_common.cpp Hopeful fix for Cygwin build (#1530) 2014-07-05 10:22:20 -07:00
env_universal_common.h Universal variable callbacks should only be announced for changed 2014-06-16 12:27:28 -07:00
env.cpp Further support for term24bit. Teach output.cpp what to do with it. 2014-09-19 18:45:04 -07:00
env.h set: Print an error when setting umask to a bad value 2014-08-21 19:06:21 -07:00
event.cpp Fixed various Undefined Behavior occurrences. 2014-03-07 18:28:16 +01:00
event.h
exec.cpp Remove INTERNAL_BUFFER, which was only used by fish_pager 2014-09-22 10:16:16 -07:00
exec.h
expand.cpp Fix the assertion failure in expand_variables() 2014-08-28 13:29:43 -07:00
expand.h Fix double expansions ($$foo) 2014-08-20 21:45:07 -07:00
fallback.cpp Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
fallback.h Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
fish_indent.cpp Shorten compilation times 2014-05-01 09:46:27 +02:00
fish_tests.cpp Allow running executables with $ in their name. 2014-09-21 23:35:19 -07:00
fish_version.cpp Shorten compilation times 2014-05-01 09:46:27 +02:00
fish_version.h Shorten compilation times 2014-05-01 09:46:27 +02:00
fish.cpp Initial work to support for term-24bit ("true color") 2014-09-19 18:45:04 -07:00
function.cpp Rework how screen size is tracked 2014-08-29 12:46:03 -07:00
function.h Fix line number reporting in new parser 2014-03-20 21:32:02 -07:00
highlight.cpp Remove a redundant ivar set 2014-09-22 10:24:10 -07:00
highlight.h Merge branch 'master' into 1218_rebase 2014-03-29 14:19:45 -07:00
history.cpp Improve history robustness against corrupt files 2014-07-29 14:42:03 -07:00
history.h Improve history robustness against corrupt files 2014-07-29 14:42:03 -07:00
input_common.cpp No need for mbstate_t to be static 2014-09-21 20:47:03 -07:00
input_common.h
input.cpp Fix build failure 2014-09-22 21:25:51 -07:00
input.h Rework mode handling of bind 2014-09-22 21:04:06 -07:00
install-sh
intern.cpp
intern.h
io.cpp Minor cleanup of redirection functions 2014-04-11 09:50:12 -07:00
io.h Remove the close_old field from io_fd_t, which is never actually 2014-04-16 15:31:28 -07:00
iothread.cpp Fix intermittent crash in iothread.cpp 2014-09-19 17:01:47 -07:00
iothread.h Initial work on strategy_named_pipe universal notifier. 2014-05-04 15:06:40 -07:00
key_reader.cpp Squelch some more warnings on Linux 2014-04-27 18:27:34 -07:00
kill.cpp
kill.h
lexicon_filter.in lexicon_filter fix for escaped options 2014-09-23 00:24:05 -07:00
lru.h
Makefile.in Implement new read --null flag 2014-09-21 19:27:26 -07:00
mimedb.cpp Fixes use-after-free issue. 2014-07-06 20:54:19 -07:00
mimedb.h
output.cpp Further support for term24bit. Teach output.cpp what to do with it. 2014-09-19 18:45:04 -07:00
output.h Further support for term24bit. Teach output.cpp what to do with it. 2014-09-19 18:45:04 -07:00
pager.cpp Merge branch 'master' into documentation-update 2014-09-07 16:37:31 +01:00
pager.h Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
parse_constants.h Implement correct error message for failed process expansion. 2014-05-30 13:50:13 -07:00
parse_execution.cpp Teach while loops to not hang forever with no-execute 2014-07-11 11:28:10 -07:00
parse_execution.h Do not continue execution if argument expansion fails. Fixes #1488 2014-05-31 12:41:27 -07:00
parse_productions.cpp Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
parse_productions.h
parse_tree.cpp Correctly complete redirections. Fixes #1296 2014-05-02 01:22:39 -07:00
parse_tree.h Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
parse_util.cpp Allow running executables with $ in their name. 2014-09-21 23:35:19 -07:00
parse_util.h Allow parse_util_detect_errors to treat incomplete strings as errors 2014-07-24 14:41:15 -07:00
parser_keywords.cpp
parser_keywords.h
parser.cpp Remove env_universal.h and env_universal.cpp from project 2014-06-18 10:14:35 -07:00
parser.h Remove the now-unused parser_t::job_create 2014-04-14 12:40:17 -07:00
path.cpp
path.h
postfork.cpp Minor cleanup of redirection functions 2014-04-11 09:50:12 -07:00
postfork.h
print_help.cpp
print_help.h
proc.cpp Don't sanity_lose if INTERNAL_BLOCK_NODEs have a null argv 2014-07-12 11:01:00 -07:00
proc.h Remove INTERNAL_BUFFER, which was only used by fish_pager 2014-09-22 10:16:16 -07:00
reader.cpp Allow U+F8FF to be typed 2014-09-21 21:03:44 -07:00
reader.h New -n option for read builtin 2014-09-03 22:48:37 -07:00
README.md README.md: document minimum Doxygen version 2014-09-12 21:35:20 +08:00
release_notes.html
sanity.cpp
sanity.h
screen.cpp Initial work to support for term-24bit ("true color") 2014-09-19 18:45:04 -07:00
screen.h Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
signal.cpp
signal.h
tokenizer.cpp
tokenizer.h
utf8.cpp Included missing stdint.h header in utf8.cpp 2014-03-23 15:09:43 +05:30
utf8.h Naive reimplementation of utf2wcs and wcs2utf in 2014-03-23 13:06:24 -07:00
util.cpp
util.h
wcstringutil.cpp Implement new read --null flag 2014-09-21 19:27:26 -07:00
wcstringutil.h Implement new read --null flag 2014-09-21 19:27:26 -07:00
wgetopt.cpp Properly handle invalid arguments in builtins 2014-07-02 17:04:58 +05:30
wgetopt.h
wildcard.cpp Don't include child directories of $PATH in completions 2014-09-20 00:31:33 -07:00
wildcard.h Clean up variable expansion, and properly handle embedded NULs 2014-08-24 14:39:56 -07:00
wutil.cpp Fix some warnings in Linux build 2014-05-31 13:46:28 -07:00
wutil.h Include a missing header for uint64_t 2014-04-29 10:09:38 -07:00
xdgmime.cpp
xdgmime.h
xdgmimealias.cpp
xdgmimealias.h
xdgmimeglob.cpp
xdgmimeglob.h
xdgmimeint.cpp
xdgmimeint.h
xdgmimemagic.cpp
xdgmimemagic.h
xdgmimeparent.cpp
xdgmimeparent.h

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/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 http://fishshell.com/docs/current/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.8.7 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 build-essential ncurses-dev libncurses5-dev gettext

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.