Skip to content

Commit

Permalink
Document Symfony CLI autocompletion
Browse files Browse the repository at this point in the history
  • Loading branch information
tucksaun committed Jul 20, 2024
1 parent 5f34920 commit 2561ea6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
9 changes: 9 additions & 0 deletions console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ completion (by default, by pressing the Tab key).
$ php vendor/bin/phpstan completion --help
$ composer completion --help
.. tip::

If you are using the :doc:`Symfony local web server</setup/symfony_server>`,

Check failure on line 103 in console.rst

View workflow job for this annotation

GitHub Actions / Lint (DOCtor-RST)

Please add a space between "Symfony local web server" and "</setup/symfony_server>" inside :doc: directive
it is recommended to use the builtin completion script that will ensure the
right PHP version and configuration is used when running the Console
Completion. Run ``symfony completion --help`` for the installation
instructions for your shell. The Symfony CLI will provide completion for the
``console`` and ``composer`` commands.

Creating a Command
------------------

Expand Down
11 changes: 11 additions & 0 deletions setup/symfony_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ Installation
The Symfony server is part of the ``symfony`` binary created when you
`install Symfony`_ and has support for Linux, macOS and Windows.

.. tip::

The Symfony CLI supports auto completion for Bash, Zsh or Fish shells. You
have to install the completion script *once*. Run ``symfony completion
--help`` for the installation instructions for your shell. After installing
and restarting your terminal, you're all set to use completion (by default,
by pressing the Tab key).

The Symfony CLI will also provide completion for the ``composer`` command
and for the ``console`` command if it detects a Symfony project.

.. note::

You can view and contribute to the Symfony CLI source in the
Expand Down

0 comments on commit 2561ea6

Please sign in to comment.