No description
Find a file
2024-12-20 13:50:59 -07:00
.builds Add test dependency (tmux) to builds.sr.ht specs 2024-08-05 10:41:17 +02:00
.github macOS codesigning: use stable Rust 2024-12-18 23:38:13 +08:00
benchmarks benchmarks: Run glob only once 2024-01-07 19:33:15 +01:00
build_tools git_version_gen: Just print the version 2024-12-06 22:12:26 +01:00
cmake Disable default features for cargo test 2024-12-11 17:05:38 +01:00
debian RPM/Debian packaging: add find dependency 2024-12-18 11:04:41 +08:00
doc_internal Build, codesign, and notarize macOS packages in CI 2024-07-05 17:29:28 -07:00
doc_src Make --install install without confirmation, and not exit 2024-12-13 19:19:26 +01:00
docker Update docker files and cirrus config 2024-08-05 10:41:17 +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 Add completions for notify-send 2024-08-18 12:18:26 +02:00
printf Improve the README of the printf crate 2024-09-23 11:16:42 -07:00
share Update fish_vi_key_bindings.fish 2024-12-20 13:50:59 -07:00
src Make full autosuggestions case-correcting again 2024-12-18 19:02:27 +01:00
tests tests/version: Update for "-beta" 2024-12-17 16:44:34 +01:00
.cirrus.yml Enable Cirrus CI again for some Linux targets 2024-08-05 10:41:17 +02:00
.clang-format Add back .clang-format 2024-08-07 13:11:22 +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 installable: Only panic without sphinx if FISH_BUILD_DOCS=1 2024-12-15 09:00:16 +01:00
Cargo.lock Update Cargo.lock 2024-12-17 16:44:10 +01:00
Cargo.toml Release 4.0b1 2024-12-17 22:51:11 +08:00
CHANGELOG.rst Release 4.0b1 2024-12-17 22:51:11 +08:00
CMakeLists.txt Make fish installable 2024-12-06 22:12:26 +01:00
CODE_OF_CONDUCT.md Add code of conduct 2020-07-06 20:13:01 +02:00
CONTRIBUTING.rst CONTRIBUTING.rst: update for Rust 2024-11-06 23:27:04 +08:00
COPYING Bring licensing information up to date and synchronise across files 2024-08-03 00:14:48 +08:00
deny.toml Add cargo-deny configuration 2024-11-29 18:17:00 +01: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: update dependencies for the terminfo database 2024-12-19 14:48:01 +08:00
GNUmakefile GNUMakefile: remove redundant CMake arguments 2020-12-29 16:31:43 +01:00
README.rst installable: Only panic without sphinx if FISH_BUILD_DOCS=1 2024-12-15 09:00:16 +01:00

.. |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 (4.0 on and onwards) cannot be installed in Cygwin, due to a lack of Rust support.

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 requires:

-  Rust (version 1.70 or later)
-  CMake (version 3.5 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

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

Additionally, running the full test suite requires Python 3, tmux, and the pexpect package.

Building from source with CMake
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Rather than building from source, consider using a packaged build for your platform. Using the
steps below makes fish difficult to uninstall or upgrade. Release packages are available from the
links above, and up-to-date `development builds of fish are available for many platforms
<https://github.com/fish-shell/fish-shell/wiki/Development-builds>`__

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

.. code:: bash

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

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

CMake Build options
~~~~~~~~~~~~~~~~~~~

In addition to the normal CMake build options (like ``CMAKE_INSTALL_PREFIX``), fish's CMake build 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.
- extra_functionsdir, extra_completionsdir and extra_confdir - to compile in an additional directory to be searched for functions, completions and configuration snippets

Building fish as self-installable (experimental)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also build fish as a self-installing binary.

This will include all the datafiles like the included functions or web configuration tool in the main ``fish`` binary.

On the first interactive run, and whenever it notices they are out of date, it will extract the datafiles to ~/.local/share/fish/install/ (currently, subject to change). You can do this manually by running ``fish --install``.

To install fish as self-installable, just use ``cargo``, like::

   cargo install --path /path/to/fish # if you have a git clone
   cargo install --git https://github.com/fish-shell/fish-shell --tag 4.0 # to build from git once 4.0 is released
   cargo install --git https://github.com/fish-shell/fish-shell # to build the current development snapshot without cloning

This will place the binaries in ``~/.cargo/bin/``, but you can place them wherever you want.

This build won't have the HTML docs (``help`` will open the online version) or translations.

It will try to build the man pages with sphinx-build. If that is not available and you would like to include man pages, you need to install it and retrigger the build script, e.g. by setting FISH_BUILD_DOCS=1::

  FISH_BUILD_DOCS=1 cargo install --path .

Setting it to "0" disables the inclusion of man pages.

You can also link this build statically (but not against glibc) and move it to other computers.

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