The user-friendly command line shell.
Go to file
Kevin Ballard f549ada16c Set up fish_{function,complete}_path properly
In the base config.fish, fish_function_path and fish_complete_path have
$__fish_datadir/{functions,completions} added to them if not already
present. For some reason they were replacing the final path component
instead of being added on to the end.
2014-08-22 11:54:58 -07:00
build_tools Pass --always to git describe to ensure we always get a version 2014-02-05 16:20:09 -08:00
doc_src Merge branch 'make_type_better' of github.com:kballard/fish-shell into kballard-make_type_better 2014-08-21 21:36:39 -07:00
etc Stomp exit status of initialization scripts so that fish starts out with $status 0 2013-04-09 23:48:03 -07:00
fish.xcodeproj Add fish_tests target to Xcode build 2014-08-04 13:32:23 -07:00
osx Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
po translations: update new strings, convert all to UTF-8 2014-03-13 21:56:04 +08:00
share Set up fish_{function,complete}_path properly 2014-08-22 11:54:58 -07:00
tests Merge branch 'make_type_better' of github.com:kballard/fish-shell into kballard-make_type_better 2014-08-21 21:36:39 -07:00
.gitattributes .gitattributes: mark most scripts in build_tools as not for export 2013-08-11 23:13:38 +08:00
.gitignore Remove old pager remnants, including documentation and references in the 2014-03-15 14:24:05 -07:00
.travis.yml Allow fast failure on Travis. 2014-06-11 20:44:41 +02: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 Support for command wrapping ("aliases") 2014-08-15 18:14:36 -07:00
builtin_complete.cpp Support for command wrapping ("aliases") 2014-08-15 18:14:36 -07:00
builtin_jobs.cpp Fix indentation 2014-06-07 23:27:06 -07:00
builtin_printf.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
builtin_set_color.cpp Make set_color fail silently if there is no argument (reintroducing 2014-03-27 13:46:33 -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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
builtin.cpp Merge branch 'make_type_better' of github.com:kballard/fish-shell into kballard-make_type_better 2014-08-21 21:36:39 -07:00
builtin.h Support for command wrapping ("aliases") 2014-08-15 18:14:36 -07:00
CHANGELOG Remove trailing whitespaces and change tabs to spaces 2012-11-18 11:23:22 +01:00
color.cpp First stab at builtin set_color. Moved set_color.cpp to builtin_set_color.cpp and taught fish about it. 2013-02-14 15:52:24 -08:00
color.h First stab at builtin set_color. Moved set_color.cpp to builtin_set_color.cpp and taught fish about it. 2013-02-14 15:52:24 -08:00
common.cpp Make escape_string transform wildcard characters 2014-08-16 19:25:36 -07:00
common.h Rename lock_t to mutex_lock_t to fix Solaris compilation 2014-07-07 00:38:37 -07:00
complete.cpp Make escape_string transform wildcard characters 2014-08-16 19:25:36 -07:00
complete.h Support for command wrapping ("aliases") 2014-08-15 18:14:36 -07:00
config.guess Update to latest config.sub and config.guess versions 2013-09-22 15:57:52 +08:00
config.sub Update to latest config.sub and config.guess versions 2013-09-22 15:57:52 +08:00
configure.ac Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
CONTRIBUTING.md Rename STYLEGUIDE.md to CONTRIBUTING.md, so GitHub would notice it. 2013-07-28 20:49:38 +02:00
create_wajig_completions.py Add the file that generated the wajig completions to the tree. This should not be installed but it should be included with the tarball. The file was written by Reuben Thomas. 2006-11-04 00:26:45 +10:00
Doxyfile Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
Doxyfile.help Made autoconf stop generating Doxyfile.help in preparation for Xcode documentation build phase 2012-12-26 23:48:11 -08:00
Doxyfile.user remove trialing spaces #2 2010-09-18 10:18:26 +08: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 set: Print an error when setting umask to a bad value 2014-08-21 19:06:21 -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 Formatting and style updates 2013-05-05 02:33:17 -07:00
exec.cpp Clean up the IFS handling in command substitution 2014-08-21 20:57:23 -07:00
exec.h Big fat refactoring of how redirections work. In fish 1.x and 2.0.0, the redirections for a process were flattened into a big list associated with the job, so there was no way to tell which redirections applied to each process. Each process therefore got all the redirections associated with the job. See https://github.com/fish-shell/fish-shell/issues/877 for how this could manifest. 2013-08-19 18:06:24 -07:00
expand.cpp Fix small misspelling in comment in expand.cpp 2014-05-31 09:08:46 +02:00
expand.h Excise use of parser_t's error() functionality. Thread a 2014-03-21 17:13:33 -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 Add a test for syntax highlighting pipes 2014-08-22 11:53:20 -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 Migrate global functions out of env_universal. Have env operate directly 2014-06-15 17:30:50 -07:00
function.cpp Fix line number reporting in new parser 2014-03-20 21:32:02 -07:00
function.h Fix line number reporting in new parser 2014-03-20 21:32:02 -07:00
highlight.cpp Highlight pipe characters correctly 2014-08-22 11:45:05 -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 Remove env_universal.h and env_universal.cpp from project 2014-06-18 10:14:35 -07:00
input_common.h Use the new input_common_add_callback mechanism to not execute callbacks while signals are blocked. Should fix https://github.com/fish-shell/fish-shell/issues/608 2013-04-03 17:26:02 -07:00
input.cpp bind should not show -k for bindings that are escape sequences, not keys 2014-07-07 10:45:26 -07:00
input.h bind should not show -k for bindings that are escape sequences, not keys 2014-07-07 10:45:26 -07:00
install-sh Update to newer install-sh version 2013-09-22 17:51:48 +08:00
intern.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
intern.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
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 Hopeful fix for hangs in iothread tests in travis-ci 2014-05-29 13:44:31 -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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
kill.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
lru.h Fix for build errors with g++ 4.0.1 2012-12-11 13:18:40 -08:00
Makefile.in Fix make test to use local functions 2014-07-14 00:46:38 -07:00
mimedb.cpp Fixes use-after-free issue. 2014-07-06 20:54:19 -07:00
mimedb.h Add header guards to the header files. 2005-10-05 01:11:39 +10:00
output.cpp Use parm_left_cursor and parm_right_cursor for bulk cursor motions. 2014-05-09 14:37:23 -07:00
output.h Use parm_left_cursor and parm_right_cursor for bulk cursor motions. 2014-05-09 14:37:23 -07:00
pager.cpp Don't show "and 1 more rows" in pager if that requires a row 2014-08-11 09:55:07 -07: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 Bringup of function definitions, switch statements with new parser 2013-12-27 03:58:42 -08:00
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 parse_util_detect_errors to treat incomplete strings as errors 2014-07-24 14:41:15 -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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
parser_keywords.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
path.h Add a fancy new paths_are_equivalent function to test for equivalent 2013-08-27 18:26:22 -07:00
postfork.cpp Minor cleanup of redirection functions 2014-04-11 09:50:12 -07:00
postfork.h Big fat refactoring of how redirections work. In fish 1.x and 2.0.0, the redirections for a process were flattened into a big list associated with the job, so there was no way to tell which redirections applied to each process. Each process therefore got all the redirections associated with the job. See https://github.com/fish-shell/fish-shell/issues/877 for how this could manifest. 2013-08-19 18:06:24 -07:00
print_help.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
print_help.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
proc.cpp Don't sanity_lose if INTERNAL_BLOCK_NODEs have a null argv 2014-07-12 11:01:00 -07:00
proc.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
reader.cpp Accepting an autosuggestion should clear the pager 2014-08-11 10:17:41 -07:00
reader.h Clean up reader_write_title to work with wcstring 2014-08-02 21:01:40 -07:00
README.md Added better build description closes #70 2014-07-01 16:08:37 +02:00
release_notes.html Release notes for fish 2.0 2013-05-15 01:02:55 -07:00
sanity.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
sanity.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
screen.cpp Fix up OSC / iTerm2 escape code parsing as part of #1565 2014-07-30 11:35:39 -07:00
screen.h Run restyle.sh to enforce style rules. 2014-03-31 10:01:39 -07:00
signal.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
signal.h Fix for issue where history file would be read immediately on launch 2012-12-04 16:00:35 -08:00
tokenizer.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
tokenizer.h Fix issues related to redirections and block level IO with new parser 2013-12-28 16:18:38 -08:00
user_doc.head.html Revert a series of accidentally rebased commits 2013-10-16 01:14:46 -07:00
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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
util.h Hack around xdm's dumb assumption that the login shell is POSIX compliant so we no longer kill OpenSUSE 2013-01-04 13:09:01 -08:00
wgetopt.cpp Properly handle invalid arguments in builtins 2014-07-02 17:04:58 +05:30
wgetopt.h Re-point some URLs at the fish homepage fishshell.com 2012-12-27 02:17:14 -08:00
wildcard.cpp Enhance file_id_t to have richer information, to guard against inode 2014-04-28 15:14:33 -07:00
wildcard.h Support for fuzzy completions 2013-05-25 15:41:18 -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 Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmime.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimealias.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmimealias.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeglob.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmimeglob.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeint.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmimeint.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimemagic.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmimemagic.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeparent.cpp Revert "Merge pull request #1317 from pullreq/cpp" 2014-02-28 02:16:48 -08:00
xdgmimeparent.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01: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 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.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 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.