Skip to content

Add current CLI commands to packages/cli/README.md #301

@thedavidprice

Description

@thedavidprice

The doc does not include the commands (with options) available along with a brief description for each. See:
https://github.com/redwoodjs/redwood/blob/master/packages/cli/README.md

  • Also needs to include info that we use Yargs for the CLI.
  • Should mention —help flag.

Running yarn rw —help outputs this list:

Commands:
  rw build [app..]    Build for production.
  rw db <command>     Database tools.                        [aliases: database]
  rw dev [app..]      Run development servers.
  rw generate <type>  Save time by generating boilerplate code.     [aliases: g]
  rw lint             Lint your files.
  rw open [port]      Open your project in your browser.
  rw test [app..]     Run Jest tests for api and web.

And here’s the cli/ package directory with all commands:
https://github.com/redwoodjs/redwood/tree/master/packages/cli/src/commands

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions