Skip to content
This repository

The user-friendly command line shell.

functions on top

latest commit 2bbb59964f
David Flores dmouse authored April 18, 2014 ridiculousfish committed April 19, 2014
Octocat-spinner-32 build_tools Pass --always to git describe to ensure we always get a version February 05, 2014
Octocat-spinner-32 doc_src Incorporate a modified UTF8 <-> wchar_t implementation from Alexey March 22, 2014
Octocat-spinner-32 etc Stomp exit status of initialization scripts so that fish starts out w… April 09, 2013
Octocat-spinner-32 fish.xcodeproj Stop linking iconv, now that we have our own utf8 conversion routines March 23, 2014
Octocat-spinner-32 osx Space and time optimizations for parse_node_t. Reduced size from 48 March 25, 2014
Octocat-spinner-32 po translations: update new strings, convert all to UTF-8 March 13, 2014
Octocat-spinner-32 share functions on top April 19, 2014
Octocat-spinner-32 tests Set the job property of block_t before expanding arguments associated April 02, 2014
Octocat-spinner-32 .gitattributes .gitattributes: mark most scripts in build_tools as not for export August 11, 2013
Octocat-spinner-32 .gitignore Remove old pager remnants, including documentation and references in the March 15, 2014
Octocat-spinner-32 .travis.yml .travis.yml: reduce verbosity of IRC notifications February 11, 2014
Octocat-spinner-32 CHANGELOG Remove trailing whitespaces and change tabs to spaces November 18, 2012
Octocat-spinner-32 CONTRIBUTING.md Rename STYLEGUIDE.md to CONTRIBUTING.md, so GitHub would notice it. July 28, 2013
Octocat-spinner-32 Doxyfile remove trialing spaces #2 September 18, 2010
Octocat-spinner-32 Doxyfile.help Made autoconf stop generating Doxyfile.help in preparation for Xcode … December 26, 2012
Octocat-spinner-32 Doxyfile.user remove trialing spaces #2 September 18, 2010
Octocat-spinner-32 Makefile.in configure/Makefile: remove unused $LIBS and $LDFLAGS complications March 30, 2014
Octocat-spinner-32 README.md README.md: document build and runtime dependencies even better. March 10, 2014
Octocat-spinner-32 autoload.cpp Use `source` instead of `.` in autoload.cpp. April 04, 2014
Octocat-spinner-32 autoload.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 builtin.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 builtin.h Fix line number reporting in new parser March 20, 2014
Octocat-spinner-32 builtin_commandline.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 builtin_complete.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 builtin_jobs.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 builtin_printf.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 builtin_set.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 builtin_set_color.cpp Make set_color fail silently if there is no argument (reintroducing March 27, 2014
Octocat-spinner-32 builtin_test.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 builtin_ulimit.cpp Fix indentation of switch statements November 19, 2012
Octocat-spinner-32 color.cpp First stab at builtin set_color. Moved set_color.cpp to builtin_set_c… February 14, 2013
Octocat-spinner-32 color.h First stab at builtin set_color. Moved set_color.cpp to builtin_set_c… February 14, 2013
Octocat-spinner-32 common.cpp Fix line number reporting in new parser March 20, 2014
Octocat-spinner-32 common.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 complete.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 complete.h Remove old fish_pager source and implementation March 15, 2014
Octocat-spinner-32 config.guess Update to latest config.sub and config.guess versions September 22, 2013
Octocat-spinner-32 config.sub Update to latest config.sub and config.guess versions September 22, 2013
Octocat-spinner-32 configure.ac configure: turn off automatic searches through non-standard directories March 30, 2014
Octocat-spinner-32 create_wajig_completions.py Add the file that generated the wajig completions to the tree. This s… November 04, 2006
Octocat-spinner-32 env.cpp Set $fish_bind_mode to default on fish startup; set $fish_key_bindings January 19, 2014
Octocat-spinner-32 env.h Rely on $PWD instead of getcwd() more often April 27, 2013
Octocat-spinner-32 env_universal.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 env_universal.h Clean up env_var_table_t. Switch from storing var_uni_entry_t* to var… February 11, 2013
Octocat-spinner-32 env_universal_common.cpp Naive reimplementation of utf2wcs and wcs2utf in March 23, 2014
Octocat-spinner-32 env_universal_common.h Large set of changes to how PATH is handled. Changed fish to no longe… February 19, 2013
Octocat-spinner-32 event.cpp Fixed various Undefined Behavior occurrences. March 07, 2014
Octocat-spinner-32 event.h Formatting and style updates May 05, 2013
Octocat-spinner-32 exec.cpp Remove the close_old field from io_fd_t, which is never actually April 16, 2014
Octocat-spinner-32 exec.h Big fat refactoring of how redirections work. In fish 1.x and 2.0.0, … August 19, 2013
Octocat-spinner-32 expand.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 expand.h Excise use of parser_t's error() functionality. Thread a March 21, 2014
Octocat-spinner-32 fallback.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 fallback.h Fix for failing to weak link wcsncasecmp - binary dies on SnowLeopard May 16, 2013
Octocat-spinner-32 fish.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 fish_indent.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 fish_tests.cpp Reduce the iterations in the iothread test to something more reasonable. April 17, 2014
Octocat-spinner-32 fishd.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 function.cpp Fix line number reporting in new parser March 20, 2014
Octocat-spinner-32 function.h Fix line number reporting in new parser March 20, 2014
Octocat-spinner-32 highlight.cpp Remove an unnecessary parse pass in highlight.cpp (oops) April 05, 2014
Octocat-spinner-32 highlight.h Merge branch 'master' into 1218_rebase March 29, 2014
Octocat-spinner-32 history.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 history.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 input.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 input.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 input_common.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 input_common.h Use the new input_common_add_callback mechanism to not execute callba… April 03, 2013
Octocat-spinner-32 install-sh Update to newer install-sh version September 22, 2013
Octocat-spinner-32 intern.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 intern.h Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 io.cpp Minor cleanup of redirection functions April 11, 2014
Octocat-spinner-32 io.h Remove the close_old field from io_fd_t, which is never actually April 16, 2014
Octocat-spinner-32 iothread.cpp Remove a debugging statement (oops) April 18, 2014
Octocat-spinner-32 iothread.h Allow autosuggestions to do job expansion. Fixes November 29, 2013
Octocat-spinner-32 key_reader.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 kill.cpp Fix the build (oops) March 29, 2013
Octocat-spinner-32 kill.h Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 lru.h Fix for build errors with g++ 4.0.1 December 11, 2012
Octocat-spinner-32 mimedb.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 mimedb.h Add header guards to the header files. October 05, 2005
Octocat-spinner-32 output.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 output.h First stab at builtin set_color. Moved set_color.cpp to builtin_set_c… February 14, 2013
Octocat-spinner-32 pager.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 pager.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_constants.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_execution.cpp Set the job property of block_t before expanding arguments associated April 02, 2014
Octocat-spinner-32 parse_execution.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_productions.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_productions.h Bringup of function definitions, switch statements with new parser December 27, 2013
Octocat-spinner-32 parse_tree.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_tree.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_util.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 parse_util.h Remove additional dead code from old parser March 20, 2014
Octocat-spinner-32 parser.cpp Remove the now-unused parser_t::job_create April 14, 2014
Octocat-spinner-32 parser.h Remove the now-unused parser_t::job_create April 14, 2014
Octocat-spinner-32 parser_keywords.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 parser_keywords.h Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 path.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 path.h Add a fancy new paths_are_equivalent function to test for equivalent August 27, 2013
Octocat-spinner-32 postfork.cpp Minor cleanup of redirection functions April 11, 2014
Octocat-spinner-32 postfork.h Big fat refactoring of how redirections work. In fish 1.x and 2.0.0, … August 19, 2013
Octocat-spinner-32 print_help.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 print_help.h Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 proc.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 proc.h Update style and formatting to conform to fish style guide. January 15, 2014
Octocat-spinner-32 reader.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 reader.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 release_notes.html Release notes for fish 2.0 May 15, 2013
Octocat-spinner-32 sanity.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 sanity.h Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 screen.cpp Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 screen.h Run restyle.sh to enforce style rules. March 31, 2014
Octocat-spinner-32 signal.cpp Fix for issue where history file would be read immediately on launch December 04, 2012
Octocat-spinner-32 signal.h Fix for issue where history file would be read immediately on launch December 04, 2012
Octocat-spinner-32 tokenizer.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 tokenizer.h Fix issues related to redirections and block level IO with new parser December 28, 2013
Octocat-spinner-32 user_doc.head.html Fix to enable momentum scrolling on iOS in new documentation October 16, 2013
Octocat-spinner-32 utf8.cpp Included missing stdint.h header in utf8.cpp March 23, 2014
Octocat-spinner-32 utf8.h Naive reimplementation of utf2wcs and wcs2utf in March 23, 2014
Octocat-spinner-32 util.cpp Apply new indentation, brace, and whitespace style November 18, 2012
Octocat-spinner-32 util.h Hack around xdm's dumb assumption that the login shell is POSIX compl… January 04, 2013
Octocat-spinner-32 wgetopt.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 wgetopt.h Re-point some URLs at the fish homepage fishshell.com December 27, 2012
Octocat-spinner-32 wildcard.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 wildcard.h Support for fuzzy completions May 25, 2013
Octocat-spinner-32 wutil.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 wutil.h Mark stdin as nonblocking if we get EWOULDBLOCK, and before handing i… April 07, 2013
Octocat-spinner-32 xdgmime.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmime.h Update Free Software Foundation address. December 13, 2013
Octocat-spinner-32 xdgmimealias.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmimealias.h Update Free Software Foundation address. December 13, 2013
Octocat-spinner-32 xdgmimeglob.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmimeglob.h Update Free Software Foundation address. December 13, 2013
Octocat-spinner-32 xdgmimeint.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmimeint.h Update Free Software Foundation address. December 13, 2013
Octocat-spinner-32 xdgmimemagic.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmimemagic.h Update Free Software Foundation address. December 13, 2013
Octocat-spinner-32 xdgmimeparent.cpp Revert "Merge pull request #1317 from pullreq/cpp" February 28, 2014
Octocat-spinner-32 xdgmimeparent.h Update Free Software Foundation address. December 13, 2013
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.

Something went wrong with that request. Please try again.