8000 Document Symfony CLI autocompletion by tucksaun · Pull Request #20056 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Document Symfony CLI autocompletion #20056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Document Symfony CLI autocompletion #20056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions console.rst
-->
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ options by pressing the Tab key.

$ php vendor/bin/phpstan completion bash | sudo tee /etc/bash_completion.d/phpstan

.. tip::

If you are using the :doc:`Symfony local web server
</setup/symfony_server>`, 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
View file
Open in desktop
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
Loading
0