fish-shell/doc_src/cmds/cd.rst

.. _cmd-cd:

cd - change directory
=====================

Synopsis
--------

**cd** [*DIRECTORY*]

Description
-----------
**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 :ref:`prevd <cmd-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.

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>`
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-cd:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`cd - change directory`
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
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-18 07:20:46 +08:00			`cd [DIRECTORY]`
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			`-----------`
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-18 07:20:46 +08:00			`cd changes the current working directory.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
cd, cdh, command, commandline Documentation. 2021-12-09 20:45:10 +08:00			If DIRECTORY is given, it will become the new directory. If no parameter is given, the :envvar:`HOME` environment variable will be used.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
cd, cdh, command, commandline Documentation. 2021-12-09 20:45:10 +08:00			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.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-18 07:20:46 +08:00			`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.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-18 07:20:46 +08:00			Fish also ships a wrapper function around the builtin cd that understands ``cd -`` as changing to the previous directory.
cd, cdh, command, commandline Documentation. 2021-12-09 20:45:10 +08:00			See also :ref:`prevd <cmd-prevd>`.
			This wrapper function maintains a history of the 25 most recently visited directories in the ``$dirprev`` and ``$dirnext`` global variables.
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-18 07:20:46 +08:00			`If you make those universal variables your cd history is shared among all fish instances.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			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.
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			`Examples`
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
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`::`

			`cd`
			`# changes the working directory to your home directory.`

			`cd /usr/src/fish-shell`
			`# changes the working directory to /usr/src/fish-shell`

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`See Also`
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
doc: add section about directory history / stack This PR also adds "See Also" section in the related commands. 2020-04-04 19:01:53 +08:00			Navigate directories using the :ref:`directory history <directory-history>` or the :ref:`directory stack <directory-stack>`