Lesson: WP-CLI Intro

[rosswintle]

I'm raising this issue to create a WP-CLI intro video tutorial to complement the course as discussed in #632

Topic Description

An introduction to WP-CLI - the WordPress command line tool

See the outline document

Objectives

• Gain an initial understanding of what WP-CLI is and why it is powerful and worth learning more about.
• Equally: understand if WP-CLI is NOT something that the trainee would want to learn more about.
• Know how to install WP-CLI (on various different platforms - bear in mind some tools like Local and DevKinsta come with WP-* CLI and many hosting environments have it pre-installed too).
• Understand some of the most useful, time-saving features of WP-CLI.
• Know at least three commands that can be used immediately.
• Understand that you can develop your own CLI commands (but not HOW to develop them other than by referencing the handbook).
• Understand how to get help from WP-CLI, both on the command line and in the documentation.
• Know where to go to find out more.

Things specifically NOT to include (with rationale):

• That you can contribute to the WP-CLI project and how to do so (because a beginner will not have the skills or knowledge required).
• Security (people may have questions about this but it should remain out of scope).

Pre-requisites

• I can use the command line/terminal/shell on my computer or server (or am willing to learn!)
• I either:
  • Have WordPress installed locally on my own computer OR
  • Have WordPress on a host that allows me to SSH to the server.
  • I understand some basic WordPress administration concepts such as posts, users, and plugins.

Related Resources

Links to related content on Learn, HelpHub, DevHub, GitHub Gutenberg Issues, DevNotes, etc.

• https://make.wordpress.org/cli/handbook/
• https://wp-cli.org/
• https://wordpress.tv/?s=wp-cli

Guidelines

Review the [team guidelines] (https://make.wordpress.org/training/handbook/guidelines/)

Tutorial Development Checklist

• Vetted by instructional designers for content idea
• Provide feedback of the idea
• Gather links to Support and Developer Docs
• Consider any MarComms (marketing communications) resources and link to those
• Review any related material on Learn
• Define several SEO keywords to use in the article and where they should be prominently used
• Description and Objectives finalized
• Create an outline of the workshop
• Tutorial submitted to the team for Q/A review https://blog.wordpress.tv/submission-guidelines/ & https://make.wordpress.org/training/2021/08/17/proposal-brand-guidelines-for-learn-wordpress-content/
• Tutorial submitted to WPTV https://wordpress.tv/submit-video/
• Tutorial published on WPTV
• Tutorial is captioned https://make.wordpress.org/training/handbook/workshops/workshop-subtitles-and-transcripts/
• Tutorial created on Learn.WordPress.org
• Tutorial post is reviewed for grammar, spelling, etc.
• Tutorial published on Learn.WordPress.org
• Tutorial announced to training team
• Tutorial announced to creator
• Tutorial announced to Marketing Team for promotion
• Gather feedback from workshop viewers/participants

[digitalchild]

For related resources, I think it would be good to have links to videos/tutorials for

• How to get WordPress running locally (windows, mac, Linux)
• Command line basics (windows WSL, OS X, Shell)

For the outline

I think talking about 3rd party WP-CLI add-ons should be covered as here are already a lot of existing tools out there.

Examples

• https://aaemnnost.tv/wp-cli-commands/login/ (generate a magic login link for any user)
• https://github.com/woocommerce/wc-smooth-generator (generate woocommerce related objects. great for creating better testing environments)

[jonathanbossenger]

If either of you is interested, I posted a handbook doc today that summarizes my process of creating technical tutorials (like this one) https://make.wordpress.org/training/handbook/tutorials/creating-a-tutorial/preparing-technical-tutorial/

If anyone needs any help creating this tutorial, please feel free to reach out to me here or on Slack.

[jonathanbossenger]

Hi folks. I wanted to check in here to see if there's anything I can help with. Perhaps I could start with a draft script for this tutorial?

[jonathanbossenger]

Noting that an introduction to WP-CLI is part of the addendum of the Introduction to WordPress Development Syllabus, and so while it's on my radar, it's not my highest priority.

I would still love to see another contributor work on this, and I'd be happy to support that contributor.