The user-friendly command line shell.
Go to file
Maxim Gonchar 1514ab8ec5 Retab
2014-01-20 17:03:46 +04:00
build_tools add correct version number to manpage output 2013-12-01 12:37:29 +08:00
doc_src fix two minor typos in tutorial 2014-01-08 20:09:32 +03: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 Factor execution aspects from parser_t to parse_execution_context_t . 2013-12-24 13:17:24 -08:00
osx Revert a series of accidentally rebased commits 2013-10-16 01:14:46 -07:00
po Integrated new German translation provided by Benjamin Weis 2013-11-03 10:07:42 -08:00
share Retab 2014-01-20 17:03:46 +04:00
tests Makefile/tests: use return values to communicate errors 2014-01-15 23:50:42 +08:00
.gitattributes .gitattributes: mark most scripts in build_tools as not for export 2013-08-11 23:13:38 +08:00
.gitignore Ignore auto-generated file command_list_toc.txt 2013-12-18 16:59:37 +05:30
autoload.cpp Miscellaneous minor fixes based on cppcheck static analyzer 2014-01-12 13:33:35 -08:00
autoload.h forward-word should accept a word of an autosuggestion 2012-12-10 16:23:08 -08:00
builtin_commandline.cpp Add kill-selection function and visual binds for 'y' and 'd' 2014-01-18 10:18:29 +01:00
builtin_complete.cpp Miscellaneous minor fixes based on cppcheck static analyzer 2014-01-12 13:33:35 -08:00
builtin_jobs.cpp Miscellaneous minor fixes based on cppcheck static analyzer 2014-01-12 13:33:35 -08:00
builtin_printf.cpp Disallow Unicode conversion specifications. 2013-11-27 21:16:34 +01:00
builtin_set_color.cpp Fix set_color crash on 'ignore' and 'reset' 2013-09-21 15:15:06 -07:00
builtin_set.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
builtin_test.cpp use wstat in test command to follow symbolic link 2013-08-25 15:54:06 -07:00
builtin_ulimit.cpp Fix indentation of switch statements 2012-11-19 00:31:03 -08:00
builtin.cpp Merge remote-tracking branch 'upstream/master' into bind_mode 2014-01-15 15:27:06 +01:00
builtin.h Bringup of function definitions, switch statements with new parser 2013-12-27 03:58:42 -08: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 Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
common.h Additional miscellaneous fixes based on cppcheck static analysis 2014-01-12 13:53:59 -08:00
complete.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
complete.h Fix for extra space when tab completing directories. Fixes #1241 2014-01-14 14:28:06 -08: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 configure/Makefile: remove unused variables and unneeded declarations 2014-01-15 23:50:42 +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 remove trialing spaces #2 2010-09-18 10:18:26 +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 Large cleanup and refactoring of unescape() function. 2013-11-24 22:58:39 -08:00
env_universal_common.h Large set of changes to how PATH is handled. Changed fish to no longer modify PATH in share/config.fish. Introduced variable fish_user_paths, and a glue function __fish_reconstruct_path that splices together PATH with fish_user_paths. Changed fish to no longer validate changes to PATH unless the paths are new (i.e. don't recheck what's already there). Modified certain sets to store const wchar_t instead of wcstring to save a few allocations. 2013-02-19 18:05:20 -08:00
env_universal.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
env_universal.h Clean up env_var_table_t. Switch from storing var_uni_entry_t* to var_uni_entry_t. Various other cleanups. 2013-02-11 23:16:50 -08:00
env.cpp Set $fish_bind_mode to default on fish startup; set $fish_key_bindings 2014-01-19 10:27:39 +01:00
env.h Rely on $PWD instead of getcwd() more often 2013-04-27 00:45:38 -07:00
event.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
event.h Formatting and style updates 2013-05-05 02:33:17 -07:00
exec.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08: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 Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
expand.h Various cleanup and tweaking of backtrace messages 2013-12-16 15:33:20 -08:00
fallback.cpp Fix formatting 2013-10-26 15:27:39 -07:00
fallback.h Fix for failing to weak link wcsncasecmp - binary dies on SnowLeopard 2013-05-16 19:45:47 -07:00
fish_indent.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
fish_pager.cpp Large cleanup and refactoring of unescape() function. 2013-11-24 22:58:39 -08:00
fish_tests.cpp fish_tests.cpp: set return value if tests fail 2014-01-15 23:50:42 +08:00
fish.cpp Relax the requirement that we find a working 'doc' directory in order 2014-01-17 14:19:00 -08:00
fishd.cpp Clean up interactive session test 2013-10-26 15:24:49 -07:00
function.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
function.h Merge branch 'master' into ast 2013-10-16 01:48:21 -07:00
highlight.cpp Merge remote-tracking branch 'upstream/master' into bind_mode 2014-01-19 11:01:24 +01:00
highlight.h Pull from upstream 2014-01-15 15:44:27 +01:00
history.cpp Ensure the loop in offset_of_next_item_fish_2_0 is executed. 2013-11-25 16:07:17 +01:00
history.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
input_common.cpp Formatting and style updates 2013-05-05 02:33:17 -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 Set $fish_bind_mode to default on fish startup; set $fish_key_bindings 2014-01-19 10:27:39 +01:00
input.h Set $fish_bind_mode to default on fish startup; set $fish_key_bindings 2014-01-19 10:27:39 +01:00
install-sh Update to newer install-sh version 2013-09-22 17:51:48 +08:00
intern.cpp Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
intern.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
io.cpp Fix io_buffer_t::print to take unsigned long argument. 2013-11-25 16:10:14 +01:00
io.h Fix the build on OS X Mavericks 2013-08-21 14:41:12 -07:00
iothread.cpp Allow autosuggestions to do job expansion. Fixes 2013-11-29 13:34:03 -08:00
iothread.h Allow autosuggestions to do job expansion. Fixes 2013-11-29 13:34:03 -08:00
key_reader.cpp Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
kill.cpp Fix the build (oops) 2013-03-29 18:05:01 -07: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 configure/Makefile: remove unused variables and unneeded declarations 2014-01-15 23:50:42 +08:00
mimedb.cpp Generate version numbers dynamically 2013-08-11 23:13:38 +08:00
mimedb.h Add header guards to the header files. 2005-10-05 01:11:39 +10:00
output.cpp Kill termio.h and sys/termios.h 2013-03-05 12:25:00 -08:00
output.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
parse_constants.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_execution.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_execution.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_productions.cpp Make RESOLVE(statement) correctly handle any keyword. Fixes #1242. 2014-01-15 01:53:40 -08:00
parse_productions.h Bringup of function definitions, switch statements with new parser 2013-12-27 03:58:42 -08:00
parse_tree.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_tree.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_util.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parse_util.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parser_keywords.cpp Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
parser_keywords.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
parser.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
parser.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
path.cpp Fix formatting 2013-10-26 15:27:39 -07: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 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
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 Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
print_help.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
proc.cpp Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
proc.h Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -08:00
reader.cpp Add kill-selection function and visual binds for 'y' and 'd' 2014-01-18 10:18:29 +01:00
reader.h Add kill-selection function and visual binds for 'y' and 'd' 2014-01-18 10:18:29 +01:00
README.md update URL for nightly builds 2013-10-29 13:20:51 +08:00
release_notes.html Release notes for fish 2.0 2013-05-15 01:02:55 -07:00
sanity.cpp Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
sanity.h Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -08:00
screen.cpp Merge remote-tracking branch 'upstream/master' into bind_mode 2014-01-15 15:27:06 +01:00
screen.h Merge remote-tracking branch 'upstream/master' into bind_mode 2014-01-15 15:27:06 +01:00
signal.cpp Fix for issue where history file would be read immediately on launch 2012-12-04 16:00:35 -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 Update style and formatting to conform to fish style guide. 2014-01-15 01:40:40 -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
util.cpp Apply new indentation, brace, and whitespace style 2012-11-18 16:30:30 -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 Fix bad error message for certain options. 2013-08-26 21:10:19 -07:00
wgetopt.h Re-point some URLs at the fish homepage fishshell.com 2012-12-27 02:17:14 -08:00
wildcard.cpp Fix formatting 2013-10-26 15:27:39 -07:00
wildcard.h Support for fuzzy completions 2013-05-25 15:41:18 -07:00
wutil.cpp Initial work towars improved error reporting. Tests currently fail. 2013-12-08 21:54:06 -08:00
wutil.h Mark stdin as nonblocking if we get EWOULDBLOCK, and before handing it off to child processes when either starting them or moving them to the foreground. 2013-04-07 12:40:08 -07:00
xdgmime.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmime.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimealias.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimealias.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeglob.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeglob.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeint.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeint.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimemagic.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimemagic.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeparent.cpp Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00
xdgmimeparent.h Update Free Software Foundation address. 2013-12-13 21:51:52 +01:00

fish - the friendly interactive shell

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 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 requires gettext for translation support.

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

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.

Optional Dependencies

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.

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.