No description
Find a file
2020-07-12 18:26:12 -05:00
.builds srht builds: Switch to pexpect 2020-06-13 19:52:47 +02:00
.github Disable macos tests on github again 2020-06-19 23:13:21 +02:00
benchmarks Reindent functions to remove useless quotes 2020-03-09 19:46:43 +01:00
build_tools Adjust deprecated stderr redirection in fish_xgettext.fish 2020-07-05 08:55:11 +02:00
cmake Remove lrand48 checks and support 2020-07-08 11:00:12 -07:00
debian debian packaging: change README.md to README.rst 2020-05-31 17:11:12 +08:00
doc_src docs: Add word splitting example 2020-07-09 18:35:41 +02:00
etc Update /etc/config.fish to use current syntax 2020-05-08 15:20:36 +08:00
osx Add the get-task-allow entitlement 2020-02-29 15:29:50 -08:00
pcre2 Mark PCRE2's packages as quiet 2020-06-06 18:55:55 -07:00
po Purge remnants of process expansion, document {fish,last}_pid 2020-05-16 11:58:12 +02:00
share Move __fish_set_lscolors to ls.fish 2020-07-12 14:18:42 -05:00
src Reformat CPP files 2020-07-12 12:21:25 -07:00
tests Adopt the new AST in fish_indent 2020-07-04 14:58:05 -07:00
.clang-format Ensure that clang-format places config.h first in header list 2019-10-13 15:45:02 -07:00
.clang-tidy [clang-tidy] remove pointless public 2020-04-05 10:13:43 +02:00
.cppcheck.rules remove pointless flock() lint warning 2017-05-09 21:03:00 -07:00
.cppcheck.suppressions cppcheck: Suppress incorrectStringBooleanError 2018-11-14 12:15:40 +01:00
.editorconfig Don't trim trailing whitespace on .rst files 2019-06-15 22:36:07 -07:00
.gitattributes We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
.gitignore gitignore __pycache__ 2020-03-21 17:48:01 -07:00
.oclint Tell oclint to ignore another idiom that is safe 2017-09-09 00:18:05 -07:00
.travis.yml travis: Remove expect 2020-06-18 17:08:10 +02:00
BSDmakefile Preserve CMake options when make is invoked 2020-07-12 18:26:12 -05:00
CHANGELOG.rst Update changelog regarding _whatis_current_token binding 2020-07-12 00:15:25 +02:00
CMakeLists.txt Put -Wno-redundant-move behind a compiler check 2020-07-04 21:14:43 -05:00
CODE_OF_CONDUCT.md Add code of conduct 2020-07-06 20:13:01 +02:00
config_cmake.h.in Remove lrand48 checks and support 2020-07-08 11:00:12 -07:00
CONTRIBUTING.rst Update some .md references 2020-05-30 10:07:21 +02:00
COPYING chore: bump copyright year 2019 → 2020 2020-03-14 14:03:09 -07:00
Dockerfile Update Dockerfile for cmake3 2019-04-28 11:41:37 -07:00
fish.desktop Add .desktop file and logo for appimage 2020-01-08 19:50:46 +01:00
fish.pc.in Use pkg-config variables 2020-04-04 13:07:54 +02:00
fish.png Add .desktop file and logo for appimage 2020-01-08 19:50:46 +01:00
fish.spec.in fish.spec: drop _docdir entirely 2020-06-17 20:59:17 +08:00
GNUmakefile Preserve CMake options when make is invoked 2020-07-12 18:26:12 -05:00
README.rst README: The gettext command is no longer required 2020-06-14 19:30:03 +02:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

`fish <https://fishshell.com/>`__ - the friendly interactive shell |Build Status|
=================================================================================

fish is a smart and user-friendly command line shell for macOS, 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 fishs design philosophy, see the `design
document <https://fishshell.com/docs/current/design.html>`__.

Quick Start
-----------

fish generally works like other shells, like bash or zsh. A few
important differences can be found at
https://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 https://fishshell.com/docs/current/index.html

You can quickly play with fish right in your browser by clicking the
button below:

|Try in browser|

Getting fish
------------

macOS
~~~~~

fish can be installed:

-  using `Homebrew <http://brew.sh/>`__: ``brew install fish``
-  using `MacPorts <https://www.macports.org/>`__:
   ``sudo port install fish``
-  using the `installer from fishshell.com <https://fishshell.com/>`__
-  as a `standalone app from fishshell.com <https://fishshell.com/>`__

Packages for Linux
~~~~~~~~~~~~~~~~~~

Packages for Debian, Fedora, openSUSE, and Red Hat Enterprise
Linux/CentOS are available from the `openSUSE Build
Service <https://software.opensuse.org/download.html?project=shells%3Afish&package=fish>`__.

Packages for Ubuntu are available from the `fish
PPA <https://launchpad.net/~fish-shell/+archive/ubuntu/release-3>`__,
and can be installed using the following commands:

::

   sudo apt-add-repository ppa:fish-shell/release-3
   sudo apt-get update
   sudo apt-get install fish

Instructions for other distributions may be found at
`fishshell.com <https://fishshell.com>`__.

Windows
~~~~~~~

-  On Windows 10, fish can be installed under the WSL Windows Subsystem
   for Linux with the instructions for the appropriate distribution
   listed above under “Packages for Linux”, or from source with the
   instructions below.
-  Fish can also be installed on all versions of Windows using
   `Cygwin <https://cygwin.com/>`__ (from the **Shells** category).

Building from source
~~~~~~~~~~~~~~~~~~~~

If packages are not available for your platform, GPG-signed tarballs are
available from `fishshell.com <https://fishshell.com/>`__ and
`fish-shell on
GitHub <https://github.com/fish-shell/fish-shell/releases>`__. See the
*Building* section for instructions.

Running fish
------------

Once installed, run ``fish`` from your current shell to try fish out!

Dependencies
~~~~~~~~~~~~

Running fish requires:

-  curses or ncurses (preinstalled on most \*nix systems)
-  some common \*nix system utilities (currently ``mktemp``), in
   addition to the basic POSIX utilities (``cat``, ``cut``, ``dirname``,
   ``ls``, ``mkdir``, ``mkfifo``, ``rm``, ``sort``, ``tee``, ``tr``,
   ``uname`` and ``sed`` at least, but the full coreutils plus find, sed
   and awk is preferred)
-  The gettext library, if compiled with
   translation support

The following optional features also have specific requirements:

-  builtin commands that have the ``--help`` option or print usage
   messages require ``ul`` and either ``nroff`` or ``mandoc`` for
   display
-  automated completion generation from manual pages requires Python
   (2.7+ or 3.3+) and possibly the ``backports.lzma`` module for Python
   2.7
-  the ``fish_config`` web configuration tool requires Python (2.7+ or
   3.3 +) and a web browser
-  system clipboard integration (with the default Ctrl-V and Ctrl-X
   bindings) require either the ``xsel``, ``xclip``,
   ``wl-copy``/``wl-paste`` or ``pbcopy``/``pbpaste`` utilities
-  full completions for ``yarn`` and ``npm`` require the
   ``all-the-package-names`` NPM module

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. (Substitute ``/usr/local/bin/fish`` with whatever path fish was
installed to, if it differs.) Log out, then log in again for the changes
to take effect.

Use the following command if fish isnt already added to ``/etc/shells``
to permit fish to be your login shell:

::

   echo /usr/local/bin/fish | sudo tee -a /etc/shells

To switch your default shell back, you can run ``chsh -s /bin/bash``
(substituting ``/bin/bash`` with ``/bin/tcsh`` or ``/bin/zsh`` as
appropriate).

Building
--------

.. _dependencies-1:

Dependencies
~~~~~~~~~~~~

Compiling fish requires:

-  a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later)
-  CMake (version 3.2 or later)
-  a curses implementation such as ncurses (headers and libraries)
-  PCRE2 (headers and libraries) - a copy is included with fish
-  gettext (headers and libraries) - optional, for translation support

Sphinx is also optionally required to build the documentation from a
cloned git repository.

Additionally, running the test suite requires python 3.3+ and the pexpect package.

Building from source (all platforms) - Makefile generator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To install into ``/usr/local``, run:

.. code:: bash

   mkdir build; cd build
   cmake ..
   make
   sudo make install

The install directory can be changed using the
``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``.

Building from source (macOS) - Xcode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

   mkdir build; cd build
   cmake .. -G Xcode

An Xcode project will now be available in the ``build`` subdirectory.
You can open it with Xcode, or run the following to build and install in
``/usr/local``:

.. code:: bash

   xcodebuild
   xcodebuild -scheme install

The install directory can be changed using the
``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``.

Help, it didnt 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 cmake ncurses-dev libncurses5-dev libpcre2-dev gettext

On RedHat, CentOS, or Amazon EC2:

::

   sudo yum install ncurses-devel

Contributing Changes to the Code
--------------------------------

See the `Guide for Developers <CONTRIBUTING.rst>`__.

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 `gitter.im
channel <https://gitter.im/fish-shell/fish-shell>`__. Or use the `fish
tag on
Stackoverflow <https://stackoverflow.com/questions/tagged/fish>`__ for
questions related to fish script and the `fish tag on
Superuser <https://superuser.com/questions/tagged/fish>`__ for all other
questions (e.g., customizing colors, changing key bindings).

Found a bug? Have an awesome idea? Please `open an
issue <https://github.com/fish-shell/fish-shell/issues/new>`__.

.. |Build Status| image:: https://travis-ci.org/fish-shell/fish-shell.svg?branch=master
   :target: https://travis-ci.org/fish-shell/fish-shell
.. |Try in browser| image:: https://cdn.rawgit.com/rootnroll/library/assets/try.svg
   :target: https://rootnroll.com/d/fish-shell/