mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-05-06 09:48:39 +08:00
48 lines
4.7 KiB
Markdown
48 lines
4.7 KiB
Markdown
# Handbook
|
||
|
||
Here are some helpful guides and resources for using WP-CLI.
|
||
|
||
Can’t find what you’re looking for? [Open an issue](https://github.com/wp-cli/handbook/issues) to request improvements.
|
||
|
||
## Guides
|
||
|
||
* **[Installing](https://make.wordpress.org/cli/handbook/guides/installing/)** - Recommended and alternative installation mechanisms.
|
||
* **[Quick start](https://make.wordpress.org/cli/handbook/guides/quick-start/)** - Where to begin after you've installed WP-CLI for the first time.
|
||
* **[Running commands remotely](https://make.wordpress.org/cli/handbook/guides/running-commands-remotely/)** - Learn how to remotely control multiple servers at once.
|
||
* **[Commands cookbook](https://make.wordpress.org/cli/handbook/guides/commands-cookbook/)** - The full 101 how commands work, writing your own, and sharing them with the world.
|
||
* **[Common issues and their fixes](https://make.wordpress.org/cli/handbook/guides/common-issues/)** - In case of fire, break glass.
|
||
* **[External resources](https://make.wordpress.org/cli/handbook/guides/external-resources/)** - Blog posts, slides and videos from users.
|
||
* **[Force output to a specific locale](https://make.wordpress.org/cli/handbook/guides/force-output-specific-locale/)** - Localisation issue
|
||
* **[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advise
|
||
* **[Sharing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/sharing-wp-cli-packages/)** - Some words about your environment
|
||
* **[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot
|
||
|
||
## References
|
||
|
||
* **[Global parameters](https://make.wordpress.org/cli/handbook/references/config/)** - 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](https://developer.wordpress.org/cli/commands/)** - Commands included in every copy of WP-CLI.
|
||
* **[Internal API](https://make.wordpress.org/cli/handbook/references/internal-api/)** - Stable utilities considered safe to use in community commands.
|
||
* **[Documentation standards](https://make.wordpress.org/cli/handbook/references/documentation-standards/)** - Standards for annotating WP-CLI commands.
|
||
* **[Hosting companies](https://make.wordpress.org/cli/handbook/references/hosting-companies/)** - List of hosting companies where WP-CLI is installed by default.
|
||
* **[Shell friends](https://make.wordpress.org/cli/handbook/references/shell-friends/)** - Helpful shortcuts for bash and zsh.
|
||
* **[Integrated tools](https://make.wordpress.org/cli/handbook/references/tools/)** - Plugins, wrappers, and other projects that integrate with WP-CLI in some form.
|
||
|
||
## Contributing
|
||
|
||
* **[Bug reports](https://make.wordpress.org/cli/handbook/contributions/bug-reports/)** - Help ensure your issue is resolved in a timely manner.
|
||
* **[Contributing](https://make.wordpress.org/cli/handbook/contributions/contributing/)** - An introduction to the contributing process.
|
||
* **[WordCamp Contributor Day](https://make.wordpress.org/cli/handbook/contributions/contributor-day/)** - Quick-start guide for WordCamp Contributor Days.
|
||
* **[Ideas](https://github.com/wp-cli/ideas)** - Up-vote existing ideas or submit your own.
|
||
* **[Governance](https://make.wordpress.org/cli/handbook/contributions/governance/)** - Summary of those behind WP-CLI.
|
||
* **[Implementation details](https://make.wordpress.org/cli/handbook/contributions/implementation-details/)** - Catalog of historical design decisions.
|
||
* **[Philosophy](https://make.wordpress.org/cli/handbook/contributions/philosophy/)** - Guidelines which inform project scope, command organization, and behavior.
|
||
* **[Pull requests](https://make.wordpress.org/cli/handbook/contributions/pull-requests/)** - Submit your first bug fix or new feature.
|
||
* **[Release checklist](https://make.wordpress.org/cli/handbook/contributions/release-checklist/)** - Tasks performed during the process of tagging a release.
|
||
* **[Roadmap](https://make.wordpress.org/cli/handbook/contributions/roadmap/)** - Where WP-CLI is going in the future.
|
||
* **[Code Review](https://make.wordpress.org/cli/handbook/contributions/code-review/)** - Quality Assurance on WP-CLI
|
||
* **[Committers credo](https://make.wordpress.org/cli/handbook/contributions/committers-credo/)** - Product quality, Stellar judgement, Consistent participation
|
||
* **[Repository Management](https://make.wordpress.org/cli/handbook/contributions/repository-management/)** - Naming, Versions, Milestones, Labels
|
||
|
||
## Misc
|
||
|
||
* **[Plugin unit tests](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/)** - How to set up and run PHPUnit tests for a WordPress plugin.
|
