README

@flayyer/cli

Flayyer CLI

📚 Please read the documentation here: https://docs.flayyer.com/docs/cli/flayyer-cli

👉 To start a new project use create-flayyer-app checkout our Getting Started guide.

Usage
Commands

Usage

$ npm install -g @flayyer/cli
$ flayyer COMMAND
running command...
$ flayyer (-v|--version|version)
@flayyer/cli/1.18.1 darwin-x64 node-v14.15.3
$ flayyer --help [COMMAND]
USAGE
  $ flayyer COMMAND
...

Commands

flayyer build [DIRECTORY]
flayyer deploy [DIRECTORY]
flayyer help [COMMAND]
flayyer start

`flayyer build [DIRECTORY]`

Build Flayyer project for production.

USAGE
  $ flayyer build [DIRECTORY]

ARGUMENTS
  DIRECTORY  [default: .] Root directory where flayyer.config.js and the /templates directory is located.

OPTIONS
  -c, --config=config  [default: flayyer.config.js] Relative path to flayyer.config.js
  -h, --help           show CLI help

DESCRIPTION
  See online documentation here: https://docs.flayyer.com/docs/cli/flayyer-cli#flayyer-build

EXAMPLES
  $ flayyer build
  $ flayyer build --help

See code: src/commands/build.ts

`flayyer deploy [DIRECTORY]`

Deploy your Flayyer templates (remember to execute 'build' before running this command)

USAGE
  $ flayyer deploy [DIRECTORY]

ARGUMENTS
  DIRECTORY  [default: .] Root directory where flayyer.config.js and the /templates directory is located.

OPTIONS
  -c, --config=config  [default: flayyer.config.js] Relative path to flayyer.config.js
  -h, --help           show CLI help
  --dry                Do everything but don't upload nor update deck

DESCRIPTION
  See online documentation here: https://docs.flayyer.com/docs/cli/flayyer-cli#flayyer-deploy

EXAMPLES
  $ flayyer deploy
  $ flayyer deploy src
  $ flayyer deploy --config flayyer.config.staging.js
  $ flayyer deploy --help

See code: src/commands/deploy.ts

`flayyer help [COMMAND]`

display help for flayyer

USAGE
  $ flayyer help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`flayyer start`

This command starts a development server using Parcel.js by default at http://localhost:7777

USAGE
  $ flayyer start

OPTIONS
  -H, --host=host        [default: localhost]
  -h, --help             show CLI help
  -p, --port=port        [default: 7777]
  --browser=(auto|none)  [default: auto]
  --https

DESCRIPTION
  See online documentation here: https://docs.flayyer.com/docs/cli/flayyer-cli#flayyer-start

EXAMPLES
  $ flayyer start
  $ flayyer start -p 8000
  $ flayyer start -p 8000 -H 0.0.0.0 --browser=none
  $ flayyer start --help

See code: src/commands/start.ts

@flayyer/clideprecated

Usage no npm install needed!