No description
Find a file
2024-08-05 10:41:17 +02:00
.builds Add test dependency (tmux) to builds.sr.ht specs 2024-08-05 10:41:17 +02:00
.github Make make_pkg.sh create fat binaries again on macOS 2024-07-07 14:53:17 -07:00
benchmarks benchmarks: Run glob only once 2024-01-07 19:33:15 +01:00
build_tools Make make_pkg.sh create fat binaries again on macOS 2024-07-07 14:53:17 -07:00
cmake Remove some now unused CMake bits 2024-07-07 16:06:45 -07:00
debian Bring licensing information up to date and synchronise across files 2024-08-03 00:14:48 +08:00
doc_internal Build, codesign, and notarize macOS packages in CI 2024-07-05 17:29:28 -07:00
doc_src add some reminders about the many places copyright information is kept 2024-08-04 21:11:21 +08:00
docker Upgrade to Alpine v3.19 and add cargo as dependency 2024-05-01 17:18:28 +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
po po/de: Fix a format string 2024-03-21 20:17:14 +01:00
printf printf: Ignore some floating point tests under i586 2024-06-23 16:14:02 -05:00
share Update p4.fish 2024-08-03 10:52:48 -05:00
src Minor cleanup of path_normalize_for_cd 2024-08-03 12:27:05 -07:00
tests Fix cd .. to the root directory 2024-07-29 10:23:29 -07:00
.cirrus.yml Cirrus: Increase clone depth 2024-06-12 17:28:23 +02:00
.editorconfig In .editorconfig replace max_line_length: none with off. 2023-07-31 09:18:46 +02:00
.gitattributes Replace references to angular with alpine 2023-10-08 12:25:43 -07:00
.gitignore gitignore: add clangd .cache directory 2023-03-05 14:04:07 +01:00
BSDmakefile Preserve CMake options when make is invoked 2020-07-12 18:26:12 -05:00
build.rs fixup! Add workaround for targets with too small a main stack size 2024-05-30 12:25:06 -05:00
Cargo.lock Rewrite float parsing to use Rust native parsing 2024-06-09 15:52:13 -07:00
Cargo.toml add some reminders about the many places copyright information is kept 2024-08-04 21:11:21 +08:00
CHANGELOG.rst Update TTY modes for external commands only after successful command 2024-08-03 17:51:48 +02:00
CMakeLists.txt Remove legacy Mac.cmake 2024-07-07 12:25:47 -07:00
CODE_OF_CONDUCT.md Add code of conduct 2020-07-06 20:13:01 +02:00
CONTRIBUTING.rst CONTRIBUTING: Remove versions 2024-04-29 22:00:59 +02:00
COPYING Bring licensing information up to date and synchronise across files 2024-08-03 00:14:48 +08:00
Dockerfile Remove remaining mentions of curses 2024-02-23 16:36:10 +01:00
fish.desktop Update fish.desktop (#8584) 2021-12-25 23:52:54 -08:00
fish.pc.in Use pkg-config variables 2020-04-04 13:07:54 +02:00
fish.png fish.png: use the same thing we ship with the docs 2021-10-16 14:12:44 -07:00
fish.spec.in fish.spec: drop C++ requirement 2024-06-12 14:14:52 +08:00
GNUmakefile GNUMakefile: remove redundant CMake arguments 2020-12-29 16:31:43 +01:00
README.rst Update README 2024-06-12 08:11:16 +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.

.. |Cirrus CI| image:: https://api.cirrus-ci.com/github/fish-shell/fish-shell.svg?branch=master
      :target: https://cirrus-ci.com/github/fish-shell/fish-shell
      :alt: Cirrus CI Build Status

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

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 downloads, screenshots and more, go to https://fishshell.com/.

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

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/>`__

Note: The minimum supported macOS version is 10.10 "Yosemite".

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 update
   sudo apt install fish

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

Windows
~~~~~~~

-  On Windows 10/11, 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 <#building>`__ section for instructions.

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

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

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

Running fish requires:

-  A terminfo database, typically from curses or ncurses (preinstalled on most \*nix systems) - this needs to be the directory tree format, not the "hashed" database.
   If this is unavailable, fish uses an included xterm-256color definition.
-  some common \*nix system utilities (currently ``mktemp``), in
   addition to the basic POSIX utilities (``cat``, ``cut``, ``dirname``,
   ``file``, ``ls``, ``mkdir``, ``mkfifo``, ``rm``, ``sort``, ``tee``, ``tr``,
   ``uname`` and ``sed`` at least, but the full coreutils plus ``find`` 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 ``nroff`` or ``mandoc`` for
   display
-  automated completion generation from manual pages requires Python 3.5+
-  the ``fish_config`` web configuration tool requires Python 3.5+ 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
-  ``colorls`` is used, if installed, to add color when running ``ls`` on platforms
   that do not have color support (such as OpenBSD)

Building
--------

.. _dependencies-1:

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

Compiling fish from a tarball requires:

-  a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later)
-  CMake (version 3.5 or later)
-  PCRE2 (headers and libraries) - optional, this will be downloaded if missing
-  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.5+ and the pexpect package.

Dependencies, git master
~~~~~~~~~~~~~~~~~~~~~~~~

Building from git master currently requires:

-  Rust (version 1.70 or later)
-  CMake (version 3.19 or later)
-  a C compiler (for system feature detection and the test helper binary)
-  PCRE2 (headers and libraries) - optional, this will be downloaded if missing
-  gettext (headers and libraries) - optional, for translation support
-  an Internet connection, as other dependencies will be downloaded automatically


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``.

Build options
~~~~~~~~~~~~~

In addition to the normal CMake build options (like ``CMAKE_INSTALL_PREFIX``), fish has some other options available to customize it.

- BUILD_DOCS=ON|OFF - whether to build the documentation. This is automatically set to OFF when Sphinx isn't installed.
- INSTALL_DOCS=ON|OFF - whether to install the docs. This is automatically set to on when BUILD_DOCS is or prebuilt documentation is available (like when building in-tree from a tarball).
- FISH_USE_SYSTEM_PCRE2=ON|OFF - whether to use an installed pcre2. This is normally autodetected.
- MAC_CODESIGN_ID=String|OFF - the codesign ID to use on Mac, or "OFF" to disable codesigning.
- WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations.

Note that fish does *not* support static linking and will attempt to error out if it detects it.

Help, it didnt build!
~~~~~~~~~~~~~~~~~~~~~~

On Debian or Ubuntu you want these packages:

::

   sudo apt install build-essential cmake libpcre2-dev gettext

On RedHat, CentOS, or Amazon EC2 everything should be preinstalled.

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 `matrix
channel <https://matrix.to/#/#fish-shell:matrix.org>`__. Or use the `fish tag
on Unix & Linux Stackexchange <https://unix.stackexchange.com/questions/tagged/fish>`__.
There is also a fish tag on Stackoverflow, but it is typically a poor fit.

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

.. |Build Status| image:: https://github.com/fish-shell/fish-shell/workflows/make%20test/badge.svg
   :target: https://github.com/fish-shell/fish-shell/actions