mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-05-02 02:41:15 -03:00
7a59540517
No need to define "cmd-foo" anchors; use :doc:`foo <cmds/foo>`
instead. If we want "cmd-foo" but it should be tested.
See also 38b24c2325 (docs: Use :doc: role when linking to commands,
2022-09-23).
52 lines
1.9 KiB
ReStructuredText
52 lines
1.9 KiB
ReStructuredText
cd - change directory
|
|
=====================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
cd [DIRECTORY]
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. only:: builder_man
|
|
|
|
NOTE: This page documents the fish builtin ``cd``.
|
|
To see the documentation on any non-fish versions, use ``command man cd``.
|
|
|
|
``cd`` changes the current working directory.
|
|
|
|
If *DIRECTORY* is given, it will become the new directory. If no parameter is given, the :envvar:`HOME` environment variable will be used.
|
|
|
|
If *DIRECTORY* is a relative path, all the paths in the :envvar:`CDPATH` will be tried as prefixes for it, in addition to :envvar:`PWD`.
|
|
It is recommended to keep **.** as the first element of :envvar:`CDPATH`, or :envvar:`PWD` will be tried last.
|
|
|
|
Fish will also try to change directory if given a command that looks like a directory (starting with **.**, **/** or **~**, or ending with **/**), without explicitly requiring **cd**.
|
|
|
|
Fish also ships a wrapper function around the builtin **cd** that understands ``cd -`` as changing to the previous directory.
|
|
See also :doc:`prevd <prevd>`.
|
|
This wrapper function maintains a history of the 25 most recently visited directories in the ``$dirprev`` and ``$dirnext`` global variables.
|
|
If you make those universal variables your **cd** history is shared among all fish instances.
|
|
|
|
As a special case, ``cd .`` is equivalent to ``cd $PWD``, which is useful in cases where a mountpoint has been recycled or a directory has been removed and recreated.
|
|
|
|
The **--help** or **-h** option displays help about using this command, and does not change the directory.
|
|
|
|
Examples
|
|
--------
|
|
|
|
::
|
|
|
|
cd
|
|
# changes the working directory to your home directory.
|
|
|
|
cd /usr/src/fish-shell
|
|
# changes the working directory to /usr/src/fish-shell
|
|
|
|
See Also
|
|
--------
|
|
|
|
Navigate directories using the :ref:`directory history <directory-history>` or the :ref:`directory stack <directory-stack>`
|