Local CLI

CLI for Local, the #1 local WordPress development tool.

⚠️ Note: This CLI is experimental and commands/arguments are subject to change. If you have questions, feature ideas, or general comments about the future of Local CLI, we encourage you to submit an Issue on GitHub.

• Requirements
• Usage
• Commands

Requirements

• Local 5.9.2 or newer, which introduced the Local GraphQL API
• Node.js
• NPM/Yarn

Usage

$ npm install -g @getflywheel/local-cli
$ local-cli COMMAND
running command...
$ local-cli (-v|--version|version)
@getflywheel/local-cli/0.0.5 darwin-x64 node-v12.13.0
$ local-cli --help [COMMAND]
USAGE
  $ local-cli COMMAND
...

Commands

• local-cli help [COMMAND]
• local-cli list-sites
• local-cli start-site SITEID
• local-cli stop-site SITEID

local-cli help [COMMAND]

display help for local-cli

USAGE
  $ local-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

local-cli list-sites

list all Local sites

USAGE
  $ local-cli list-sites

EXAMPLE
  $ local-cli list

See code: src/commands/list-sites.ts

local-cli start-site SITEID

start a Local site and all of its services

USAGE
  $ local-cli start-site SITEID

EXAMPLE
  $ local-cli start-site 6mC6PsMCh

See code: src/commands/start-site.ts

local-cli stop-site SITEID

stop a Local site and all of its services

USAGE
  $ local-cli stop-site SITEID

OPTIONS
  -h, --help  show CLI help

See code: src/commands/stop-site.ts