fish-shell/doc_src/cmds/fish_config.rst

.. _cmd-fish_config:

fish_config - start the web-based configuration interface
=========================================================

Synopsis
--------

::

    fish_config
    fish_config browse
    fish_config prompt (choose | list | save | show)
    fish_config theme (choose | demo | dump | list | save | show)

Description
-----------

``fish_config`` is used to configure fish.

Without arguments or with the ``browse`` command it starts the web-based configuration interface. The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration. It starts a local web server and opens a browser window. When you are finished, close the browser window and press the Enter key to terminate the configuration session.

If the ``BROWSER`` environment variable is set, it will be used as the name of the web browser to open instead of the system default.

With the ``prompt`` command ``fish_config`` can be used to view and choose a prompt from fish's sample prompts inside the terminal directly.

Available subcommands for the ``prompt`` command:

- ``choose`` loads a sample prompt in the current session.
- ``list`` lists the names of the available sample prompts.
- ``save`` saves the current prompt to a file (via :ref:`funcsave <cmd-funcsave>`).
- ``show`` shows what the given sample prompts (or all) would look like.

With the ``theme`` command ``fish_config`` can be used to view and choose a theme (meaning a color scheme) inside the terminal.

Available subcommands for the ``theme`` command:

- ``choose`` loads a sample theme in the current session.
- ``demo`` displays some sample text in the current theme.
- ``dump`` prints the current theme in a loadable format.
- ``list`` lists the names of the available sample themes.
- ``save`` saves the current prompt to :ref:`universal variables <variables-universal>`.
- ``show`` shows what the given sample theme (or all) would look like.

The themes are loaded from the theme directory shipped with fish or a ``themes`` directory in the fish configuration directory (typically ``~/.config/fish/themes``).

Example
-------

``fish_config`` or ``fish_config browse`` opens a new web browser window and allows you to configure certain fish settings.

``fish_config prompt show`` demos the available sample prompts.

``fish_config prompt choose disco`` makes the disco prompt the prompt for the current session. This can also be used in :ref:`config.fish <configuration>` to set the prompt.

``fish_config prompt save`` saves the current prompt to an :ref:`autoloaded <syntax-function-autoloading>` file.

``fish_config prompt save default`` chooses the default prompt and saves it.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-fish_config:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`fish_config - start the web-based configuration interface`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`=========================================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`Synopsis`
			`--------`

			`::`

Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			`fish_config`
			`fish_config browse`
			`fish_config prompt (choose \| list \| save \| show)`
fish_config: Add CLI-based theme selector `fish_config theme`: - `list` to list all available themes (files in the two theme directories - either the web_config/themes one or ~/.config/fish/themes!) - `show` to show select (or all) themes right in the terminal - this starts another fish that reads the theme file and prints the sample text, manually colored - `choose` to load a theme now, setting the variables globally - `save` to load a theme and save the variables universally - `dump` to write the current theme in .theme format (to stdout) - `demo` to display the current theme 2021-07-10 16:26:58 +08:00			`fish_config theme (choose \| demo \| dump \| list \| save \| show)`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			``fish_config`` is used to configure fish.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			Without arguments or with the ``browse`` command it starts the web-based configuration interface. The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration. It starts a local web server and opens a browser window. When you are finished, close the browser window and press the Enter key to terminate the configuration session.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			If the ``BROWSER`` environment variable is set, it will be used as the name of the web browser to open instead of the system default.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			With the ``prompt`` command ``fish_config`` can be used to view and choose a prompt from fish's sample prompts inside the terminal directly.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			Available subcommands for the ``prompt`` command:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			- ``choose`` loads a sample prompt in the current session.
			- ``list`` lists the names of the available sample prompts.
			- ``save`` saves the current prompt to a file (via :ref:`funcsave <cmd-funcsave>`).
			- ``show`` shows what the given sample prompts (or all) would look like.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
fish_config: Add CLI-based theme selector `fish_config theme`: - `list` to list all available themes (files in the two theme directories - either the web_config/themes one or ~/.config/fish/themes!) - `show` to show select (or all) themes right in the terminal - this starts another fish that reads the theme file and prints the sample text, manually colored - `choose` to load a theme now, setting the variables globally - `save` to load a theme and save the variables universally - `dump` to write the current theme in .theme format (to stdout) - `demo` to display the current theme 2021-07-10 16:26:58 +08:00			With the ``theme`` command ``fish_config`` can be used to view and choose a theme (meaning a color scheme) inside the terminal.

			Available subcommands for the ``theme`` command:

			- ``choose`` loads a sample theme in the current session.
			- ``demo`` displays some sample text in the current theme.
			- ``dump`` prints the current theme in a loadable format.
			- ``list`` lists the names of the available sample themes.
			- ``save`` saves the current prompt to :ref:`universal variables <variables-universal>`.
			- ``show`` shows what the given sample theme (or all) would look like.

			The themes are loaded from the theme directory shipped with fish or a ``themes`` directory in the fish configuration directory (typically ``~/.config/fish/themes``).

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00			``fish_config`` or ``fish_config browse`` opens a new web browser window and allows you to configure certain fish settings.

			``fish_config prompt show`` demos the available sample prompts.

docs: Don't speak of "initialization files" The file is called "config.fish", not "init.fish". We'll call it "configuration" now. "Initialization" might be slightly more precise, but in an irritating way. Also some wording improvements to the section. In particular we now mention config.fish early, before the whole shebang. 2021-05-28 23:21:49 +08:00			``fish_config prompt choose disco`` makes the disco prompt the prompt for the current session. This can also be used in :ref:`config.fish <configuration>` to set the prompt.
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00
Fix doc reference 2021-05-02 01:44:15 +08:00			``fish_config prompt save`` saves the current prompt to an :ref:`autoloaded <syntax-function-autoloading>` file.
Add prompt selector It's a bit weird to have to fire up a browser to get fish_config to choose a prompt. So this adds a `prompt` subcommand to `fish_config`: - `fish_config prompt list` shows all the available prompt names - `fish_config prompt show` demos the available sample prompts - `fish_config prompt choose` sources a prompt - `fish_config prompt save` makes the choice permanent A bare `fish_config` or `fish_config browse` opens the web UI. Part of #3625. TODO: This shows the right prompt on a new line. Showing it in-line is awkward to do because we'd have to move it to the right. 2021-04-23 00:27:25 +08:00
			``fish_config prompt save default`` chooses the default prompt and saves it.