Closed
Description
Completion of command arguments and options is coming in Symfony 5.4 (#38275). Command and option names are already autocompleted, but argument and option values needs to be implemented on each command.
As an example, #42251 added completion to secrets:remove
.
This feature needs to be implemented on Symfony commands that has predictable values for their arguments and options.
Some guidelines:
- Don't complete file/directory paths for now. See [DX] Add completion to Symfony commands #43594 (comment)
- You don't need to filter the suggestions in PHP,
compgen
(used by the shell script) does this for you based on the suggestions provided by PHP - You can use the debugging utility while working on providing suggestions. See [DX] Add completion to Symfony commands #43594 (comment)
PLEASE, comment here BEFORE starting to work on something and WAIT for the confirmation to avoid duplicate work.
All commands have been claimed
- Command
debug:event-dispatcher
(event
,--dispatcher
,--format
) @stephenkhoo [Console] Add auto-completion to debug:event-dispatcher #43859 - Command
debug:config
(name
,path
) @eclairia Add completion for DebugConfig name and path arguments #43850 - Command
debug:autowiring
(search
) @eclairia feat: add completion for DebugAutowiring search argument #43838 - Command
messenger:failed:remove
(id
,--transport
) @scyzoryck [Messenger] Add command completion for failed messages #43663 - Command
messenger:failed:retry
(id
,--transport
) @scyzoryck [Messenger] Add command completion for failed messages #43663 - Command
messenger:failed:show
(id
,--transport
) @scyzoryck [Messenger] Add command completion for failed messages #43663 - Command
debug:container
(name
) @GromNaN [Framework] Add completion to debug:container #43857 - Command
messenger:consume
(receivers
,--bus
,--queues
) @GromNaN [Messenger] Add completion to command messenger:consume #43891 - Command
debug:firewall
(name
,--format
) @IonBazan [Console] add suggestions for debug commands: firewall, form, messenger, router #43598 - Command
debug:form
(name
,--format
) @IonBazan [Console] add suggestions for debug commands: firewall, form, messenger, router #43598 - Command
debug:messenger
(bus
) @IonBazan [Console] add suggestions for debug commands: firewall, form, messenger, router #43598 - Command
debug:router
(name
) @IonBazan [Console] add suggestions for debug commands: firewall, form, messenger, router #43598 - Command
cache:pool:clear
(pools
) @andyexeter Add completion for cache:pool:clear and cache:pool:delete commands #43621 - Command
cache:pool:delete
(pool
,key
) @andyexeter Add completion for cache:pool:clear and cache:pool:delete commands #43621 - Command
completion
(shell
) @dkarlovi [Console] feat: add completion for CompletionCommand "shell" argument #43615 - Command
config:dump-reference
(name
,path
) @StaffNowa [FrameworkBundle] Add completion for config:dump-reference #43682 - Command
help
(command_name
,--format
) @GromNaN [Console] Add completion to help & list commands #43596 - Command
debug:translation
(locale
,bundle
,--domain
) @alexandre-daubois [FrameworkBundle] Add completion to debug:translation command #43644 - Command
debug:twig
(name
,--filter
,--format
) @StaffNowa Add completion for debug:twig #43846 - Command
list
(namespace
,--format
) @GromNaN [Console] Add completion to help & list commands #43596 - Command
lint:twig
(filename
,--format
) @makraz Add suggestions for the option 'format' of lints commands: twig, yaml and xliff #43680 - Command
lint:xliff
(filename
,--format
) @makraz Add suggestions for the option 'format' of lints commands: twig, yaml and xliff #43680 - Command
lint:yaml
(filename
,--format
,--exclude
) @makraz Add suggestions for the option 'format' of lints commands: twig, yaml and xliff #43680 - Command
messenger:setup-transports
(transport
) @Tayfun74 [Console] Add completion to messenger:setup-transports command #43640 - Command
secrets:remove
(name
) @GromNaN [Console] [Framework] Add completion to secrets:set and fix secrets:remove #43626 - Command
secrets:set
(name
,file
) @GromNaN [Console] [Framework] Add completion to secrets:set and fix secrets:remove #43626 - Command
security:encode-password
(user-class
) @94noni [PasswordHasher] Add autocompletion for security commands #43653 - Command
security:hash-password
(user-class
) @94noni [PasswordHasher] Add autocompletion for security commands #43653 - Command
server:dump
(--format
) @alexandre-daubois [VarDumper] Add completion to server:dump command #43683 - Command
translation:pull
(provider
,--domains
,--locales
,--format
) @welcoMattic [Translation] Add completion feature on translation pull and push commands #43672 - Command
translation:push
(provider
,--domains
,--locales
) @welcoMattic [Translation] Add completion feature on translation pull and push commands #43672 - Command
translation:update
(locale
,bundle
,--format
,--domain
,--sort
) @stephenkhoo [FrameworkBundle] Add completion feature on translation:update command #43676 - Command
ulid:generate
(--format
) @StaffNowa [Uid] Allow use autocompletion #43639 - Command
uuid:generate
(--format
) @StaffNowa [Uid] Allow use autocompletion #43639 - Command
workflow:dump
(name
,marking
,--label
,--format
) @StaffNowa StaffNowa [FrameworkBundle] Add completion for workflow:dump #43848
Commands that does not require auto-completion:
- Command
about
- Command
assets:install
(target
) (directory completion) - Command
cache:clear
- Command
cache:pool:list
- Command
cache:pool:prune
- Command
cache:warmup
- Command
debug:dotenv
- Command
dotenv:dump
- Command
debug:validator
(class
) @Kocal completion support not yet possible - Command
lint:container
- Command
messenger:stop-workers
- Command
router:match
(path_info
) - Command
secrets:decrypt-to-local
- Command
secrets:encrypt-from-local
- Command
secrets:generate-keys
- Command
secrets:list
- Command
server:log
(--host
,--format
) @StaffNowa [MonologBridge] Add completion for server:log #43892 - Command
ulid:inspect
- Command
uuid:inspect