@blitzjs/cli

blitz-cli

Blitz CLI

Contributing

Run yarn from the monorepo root

Run locally from this directory: yarn b [COMMAND]

Run tests: yarn test

Build package: yarn build

• blitz-cli
• Usage
• Commands

Usage

$ npm install -g @blitzjs/cli
$ blitz COMMAND
running command...
$ blitz (-v|--version|version)
@blitzjs/cli/0.0.1-canary.1 darwin-x64 node-v12.16.1
$ blitz --help [COMMAND]
USAGE
  $ blitz COMMAND
...

Commands

• blitz build
• blitz console
• blitz db COMMAND
• blitz help [COMMAND]
• blitz new [PATH]
• blitz start
• blitz test [WATCH]

blitz build

Create a production build

USAGE
  $ blitz build

ALIASES
  $ blitz b

blitz console

Run project REPL

USAGE
  $ blitz console

ALIASES
  $ blitz c

blitz db COMMAND

Run project database commands

USAGE
  $ blitz db COMMAND

ARGUMENTS
  COMMAND  Run specific db command

See code: lib/commands/db.js

blitz help [COMMAND]

display help for blitz

USAGE
  $ blitz help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

blitz new [PATH]

Create a new Blitz project

USAGE
  $ blitz new [PATH]

ARGUMENTS
  PATH  path to the new project, defaults to the current directory

OPTIONS
  -h, --help     show CLI help
  -t, --[no-]ts  generate a TypeScript project
  --dry-run      show what files will be created without writing them to disk
  --[no-]yarn    use Yarn as the package manager

blitz start

Start a development server

USAGE
  $ blitz start

OPTIONS
  -p, --production  Create and start a production server

ALIASES
  $ blitz s

blitz test [WATCH]

Run project tests

USAGE
  $ blitz test [WATCH]

ARGUMENTS
  WATCH  Run test:watch

ALIASES
  $ blitz t

See code: lib/commands/test.js