handbook/references.md
Copilot 4e986a9f9d
Document guidelines for use of exit codes within commands (#632)
* Initial plan

* Document guidelines for use of exit codes within commands

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

* Remove ## EXIT STATUS PHPDoc section references per review feedback

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

* Update references/exit-codes.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update references/exit-codes.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Rename 'Using non-standard exit codes' section for clarity

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
Co-authored-by: Pascal Birchler <pascalb@google.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-20 00:03:05 +01:00

1.4 KiB

References

  • Argument Syntax - Explanation of the syntax conventions used in command synopsis.
  • Global parameters - Variables defining how a command is executed, including which WordPress user the command is run as and which WordPress instance the command is run against.
  • Built-in commands - Commands included in every copy of WP-CLI.
  • Internal API - Stable utilities considered safe to use in community commands.
  • Documentation standards - Standards for annotating WP-CLI commands.
  • Exit codes - Guidelines for using and documenting exit codes in WP-CLI commands.
  • Hosting companies - List of hosting companies where WP-CLI is installed by default.
  • Shell friends - Helpful shortcuts for bash and zsh.
  • Integrated tools - Plugins, wrappers, and other projects that integrate with WP-CLI in some form.