useflyyer/flyyer-cli

Command-line interface to develop dynamic og:images via https://flyyer.io | Generate social share images with web technologies

@flyyer/cli

Flyyer CLI

📚 Please read the documentation here: https://docs.flyyer.io/docs/cli/flyyer-cli

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

• Usage
• Commands

Usage

$ npm install -g @flyyer/cli
$ flyyer COMMAND
running command...
$ flyyer (-v|--version|version)
@flyyer/cli/2.0.2 darwin-x64 node-v16.4.2
$ flyyer --help [COMMAND]
USAGE
  $ flyyer COMMAND
...

Commands

• flyyer build [DIRECTORY]
• flyyer deploy [DIRECTORY]
• flyyer help [COMMAND]
• flyyer start

flyyer build [DIRECTORY]

Build Flyyer project for production.

USAGE
  $ flyyer build [DIRECTORY]

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

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

DESCRIPTION
  See online documentation here: https://docs.flyyer.io/docs/cli/flyyer-cli#flyyer-build

EXAMPLES
  $ flyyer build
  $ flyyer build --help

See code: src/commands/build.ts

flyyer deploy [DIRECTORY]

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

USAGE
  $ flyyer deploy [DIRECTORY]

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

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

DESCRIPTION
  See online documentation here: https://docs.flyyer.io/docs/cli/flyyer-cli#flyyer-deploy

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

See code: src/commands/deploy.ts

flyyer help [COMMAND]

display help for flyyer

USAGE
  $ flyyer help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

flyyer start

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

USAGE
  $ flyyer 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.flyyer.io/docs/cli/flyyer-cli#flyyer-start

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

See code: src/commands/start.ts