WordPress / WordPress/Learn

Lesson: WP-CLI Intro

Open
#829 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
333
Forks
127
Avg merge
1d 7h
Merged PRs (30d)
11

Description

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.

Guidelines

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

Tutorial Development Checklist

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked outline document, then review the WP-CLI handbook and the tutorial development checklist. Define the lesson around the stated objectives and exclusions, then complete review, captioning, and publication on WordPress.tv and Learn.WordPress.org.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.