The user-friendly command line shell.
Go to file
David Adam 0effcf6df1 debian packaging: maintain in fish-shell tree
Imported from https://github.com/zanchey/fish-build/

Work on #2020.

Note that this is explicitly removed from `git archive` tarballs due to
https://wiki.debian.org/UpstreamGuide#Pristine_Upstream_Source
2015-07-09 12:07:44 +08:00
build_tools Don't require .git before running git-describe 2014-10-27 15:46:22 -07:00
debian debian packaging: maintain in fish-shell tree 2015-07-09 12:07:44 +08:00
doc_src Further tweak the language about setting PATH in the tutorial 2015-07-03 12:46:40 -07:00
etc
fish.xcodeproj mimedb: kill mimedb.h 2015-05-21 16:49:25 +08:00
osx Merge branch 'Integration_2.2.0' 2015-05-21 15:32:23 +08:00
po translations: update new strings 2015-04-13 22:19:29 +08:00
share machinectl: Fix fatal errors in __fish_systemd_has_machine_image 2015-07-02 14:36:48 +08:00
tests Fix wildcard expansion in directories without read permissions 2015-06-20 12:32:30 -07:00
.gitattributes debian packaging: maintain in fish-shell tree 2015-07-09 12:07:44 +08:00
.gitignore .gitignore: fishd is dead 2015-04-12 23:58:55 +08:00
.travis.yml travis: parallel make 2015-03-20 14:53:37 +08:00
autoload.cpp Don't evict autoloaded functions from background threads 2015-03-23 12:31:22 -07:00
autoload.h
builtin_commandline.cpp Unescape the token returned by builtin_commandline 2015-05-22 08:46:23 +08:00
builtin_complete.cpp complete: recognise -w short option for --wraps 2014-11-04 23:33:31 +08:00
builtin_jobs.cpp
builtin_printf.cpp Make octal/hex escapes in printf and echo output literal bytes 2015-01-15 11:21:07 -08:00
builtin_set_color.cpp use configure to define NOMACROS 2014-12-21 23:38:02 +08:00
builtin_set.cpp Update various strings for translation, avoid _ for non-translations 2014-11-25 15:37:30 +08:00
builtin_test.cpp
builtin_ulimit.cpp Remove my_wcswidth() in favor of fish_wcswidth() 2014-09-25 18:04:11 -07:00
builtin.cpp Stop showing help for function on an error 2015-05-17 14:20:18 -07:00
builtin.h
color.cpp Solaris build fixes: use memset instead of bzero 2014-12-21 23:38:03 +08:00
color.h
common.cpp Correctly handle mixing named arguments with function name 2015-05-17 14:17:01 -07:00
common.h Correctly handle mixing named arguments with function name 2015-05-17 14:17:01 -07:00
complete.cpp Use natural (digit-sequence-aware) sorting for wildcard expansion 2015-03-23 11:13:26 -07:00
complete.h Use natural (digit-sequence-aware) sorting for wildcard expansion 2015-03-23 11:13:26 -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 Revert "Automatically add include paths for ncurses on Cygwin" 2015-06-26 13:14:30 +08:00
CONTRIBUTING.md
COPYING Move LICENSE to COPYING and update text. 2014-10-24 17:40:35 +08:00
create_wajig_completions.py
Dockerfile math requires bc package 2015-01-22 14:47:28 +08:00
Doxyfile
Doxyfile.help
Doxyfile.user
env_universal_common.cpp Fix brace style in one line 2015-06-01 23:03:23 -07:00
env_universal_common.h the slow death of fishd continues 2015-07-02 14:36:31 +08:00
env.cpp Correctly un-export an env var when it is shadowed 2015-06-12 16:05:59 -07:00
env.h Add new functions flag -V/--inherit-variable 2014-10-02 18:41:39 -07:00
event.cpp Rename events and simplify signal event handling 2014-12-29 00:38:11 -08:00
event.h
exec.cpp Ignore user-supplied fd redirections above 2 for builtins 2015-01-08 10:44:05 -08:00
exec.h Rework file descriptor handling 2015-01-07 18:07:06 -08:00
expand.cpp Pass the character index, not the character, to parse_util_expand_variable_error 2015-05-15 17:56:12 -07:00
expand.h Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
fallback.cpp use configure to define NOMACROS 2014-12-21 23:38:02 +08:00
fallback.h Remove del_curterm workaround on *BSD. 2014-12-08 08:01:03 +08:00
fish_indent.cpp Close <code> before <pre> in fish_indent 2014-12-24 14:17:06 -08:00
fish_tests.cpp Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
fish_version.cpp
fish_version.h
fish.cpp fish.cpp: check for fishd from old version and warn if reachable 2015-04-12 23:58:55 +08:00
fish.pc.in fish.pc: add pkgconfig file for fish 2014-10-01 22:15:24 +08:00
function.cpp Tombstone only when explicitly removing a function. 2015-04-08 10:46:38 -07:00
function.h Revert 1349d12 and properly fix #213 2015-04-06 00:10:55 -07:00
highlight.cpp Teach the highlighter about multiple adjacent square bracket expansions 2014-09-30 11:15:22 -07:00
highlight.h
history.cpp Use mode 0600 for history file 2015-04-29 17:52:50 -07:00
history.h Support for a "pending item" in history. 2015-04-20 02:04:17 -07:00
input_common.cpp Change lookahead_list into a queue 2015-04-19 16:56:48 -07:00
input_common.h Change lookahead_list into a queue 2015-04-19 16:56:48 -07:00
input.cpp Add 'bigword' vi key bindings 2015-06-04 12:09:02 -07:00
input.h Add 'bigword' vi key bindings 2015-06-04 12:09:02 -07:00
install-sh Update to newer install-sh version 2015-05-28 12:30:34 +08:00
intern.cpp
intern.h
io.cpp Rework file descriptor handling 2015-01-07 18:07:06 -08:00
io.h Ignore user-supplied fd redirections above 2 for builtins 2015-01-08 10:44:05 -08:00
iothread.cpp
iothread.h Use iothread_perform variant that doesn't take a completion callback 2015-01-14 10:05:07 -08:00
key_reader.cpp
kill.cpp Make escape() return a wcstring 2014-09-25 18:20:03 -07:00
kill.h
lexicon_filter.in Tweak lexicon_filter.in for GNU sed 2014-10-01 18:19:38 -07:00
lru.h Don't evict autoloaded functions from background threads 2015-03-23 12:31:22 -07:00
Makefile.in Rewrite of fish_indent 2014-12-23 15:32:01 -08:00
mimedb.cpp
output.cpp use configure to define NOMACROS 2014-12-21 23:38:02 +08:00
output.h Include fallback.h in output.h to avoid a compile error 2014-12-23 12:02:09 -08:00
pager.cpp Add paging into navigating pager 2015-03-20 14:41:38 +08:00
pager.h Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -07:00
parse_constants.h Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
parse_execution.cpp Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
parse_execution.h Pass entire argv content to fish_command_not_found recipients 2015-04-19 15:50:10 -07:00
parse_productions.cpp Simplify begin_header production 2015-04-13 13:23:59 +08:00
parse_productions.h
parse_tree.cpp Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
parse_tree.h Simplify begin_header production 2015-04-13 13:23:59 +08:00
parse_util.cpp Remove a redundant implementation of append_syntax_error 2015-04-29 17:02:32 -07:00
parse_util.h Rework error messages to be shorter and to handle more special bash-isms 2015-04-29 16:53:02 -07:00
parser_keywords.cpp Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -07:00
parser_keywords.h Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -07:00
parser.cpp Stop blocking signals within job_promote 2014-12-29 00:56:27 -08:00
parser.h Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -07:00
path.cpp Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -07:00
path.h
postfork.cpp Rework file descriptor handling 2015-01-07 18:07:06 -08:00
postfork.h
print_help.cpp
print_help.h
proc.cpp Allow fish to properly exit from job_continue when receiving a signal 2015-02-27 09:56:19 -08:00
proc.h Clean up some job status messages 2014-11-03 10:56:16 -08:00
reader.cpp Rework how the mode is reported in fish_vi_mode 2015-06-14 11:36:11 -07:00
reader.h Use a more appropriate type for the reader_test function 2015-05-02 17:49:38 -07:00
README.md Use svg instead of png to get better image quality 2015-01-17 11:42:54 +01:00
release_notes.html
sanity.cpp
sanity.h
screen.cpp use configure to define NOMACROS 2014-12-21 23:38:02 +08:00
screen.h
signal.cpp
signal.h
tokenizer.cpp Add 'bigword' vi key bindings 2015-06-04 12:09:02 -07:00
tokenizer.h Add 'bigword' vi key bindings 2015-06-04 12:09:02 -07:00
utf8.cpp
utf8.h
util.cpp
util.h
wcstringutil.cpp
wcstringutil.h
wgetopt.cpp
wgetopt.h
wildcard.cpp Fix wildcard expansion in directories without read permissions 2015-06-20 12:32:30 -07:00
wildcard.h Revert "Prepend ./ to "flag-like file" wildcard expansions and completions" 2014-09-25 22:18:36 -07:00
wutil.cpp Solaris build fixes: use _sys_errs if available 2014-12-21 23:38:09 +08:00
wutil.h Remove a bunch of dead code identified by cppcheck 2014-10-31 01:15:50 -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.