Skip to content

Latest commit

 

History

History
301 lines (218 loc) · 7.37 KB

README.md

File metadata and controls

301 lines (218 loc) · 7.37 KB
Raw

forumone-cli

CLI wrapper for Docker-based projects

Usage

$ npm install -g forumone-cli
$ f1 COMMAND
running command...
$ f1 (-v|--version|version)
forumone-cli/1.7.1 darwin-x64 node-v10.16.3
$ f1 --help [COMMAND]
USAGE
  $ f1 COMMAND
...

Commands

f1 build

build or rebuild all images

USAGE
  $ f1 build

OPTIONS
  -h, --help       show CLI help
  -v, --verbose    print command information prior to execution
  --dry-run        print command instead of running it
  --[no-]parallel  build in parallel (defaults to true)
  --[no-]pull      pull latest docker image versions (defaults to true)

See code: src/commands/build.ts

f1 cap:stage

create new capistrano stage(s)

USAGE
  $ f1 cap:stage

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  print command information prior to execution
  --dry-run      print command instead of running it

See code: src/commands/cap/stage.ts

f1 composer

run composer commands

USAGE
  $ f1 composer

OPTIONS
  -h, --help     show CLI help
                 Putting "--" at the end of your command, then adding additional flags (like --help) will run that flag
                 on the native command

  -v, --verbose  print command information prior to execution

  --dry-run      print command instead of running it

See code: src/commands/composer.ts

f1 doctor

diagnose potential issues

USAGE
  $ f1 doctor

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  print system info

See code: src/commands/doctor.ts

f1 down

stop and optionally clean a project

USAGE
  $ f1 down

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  print command information prior to execution
  --clean        remove images and volumes
  --dry-run      print command instead of running it

See code: src/commands/down.ts

f1 drush

run drush commands

USAGE
  $ f1 drush

OPTIONS
  -h, --help     show CLI help
                 Putting "--" at the end of your command, then adding additional flags (like --help) will run that flag
                 on the native command

  -v, --verbose  print command information prior to execution

  --dry-run      print command instead of running it

See code: src/commands/drush.ts

f1 help [COMMAND]

display help for f1

USAGE
  $ f1 help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

f1 init

create a new project in the current directory

USAGE
  $ f1 init

OPTIONS
  -h, --help                                                show CLI help
  -v, --verbose                                             print command information prior to execution
  --dry-run                                                 print command instead of running it
  --next                                                    use prerelease generator for testing
  --sub-generator=manifest|buildkite-pipeline|code-quality  run a specific sub-generator within generator-web-starter

See code: src/commands/init.ts

f1 new TARGET

Create a new project in a new directory.

USAGE
  $ f1 new TARGET

ARGUMENTS
  TARGET  directory name to create

OPTIONS
  -h, --help                                                show CLI help
  -v, --verbose                                             print command information prior to execution
  --dry-run                                                 print command instead of running it
  --next                                                    use prerelease generator for testing
  --sub-generator=manifest|buildkite-pipeline|code-quality  run a specific sub-generator within generator-web-starter

See code: src/commands/new.ts

f1 run SERVICE

run an arbitrary compose service

USAGE
  $ f1 run SERVICE

ARGUMENTS
  SERVICE  compose service name

OPTIONS
  -h, --help     show CLI help
                 Putting "--" at the end of your command, then adding additional flags (like --help) will run that flag
                 on the native command

  -v, --verbose  print command information prior to execution

  --dry-run      print command instead of running it

See code: src/commands/run.ts

f1 theme:build

[DEPRECATED] run gesso-related build tasks

USAGE
  $ f1 theme:build

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  print command information prior to execution
  --css          build CSS
  --dry-run      print command instead of running it
  --pattern-lab  build PL

See code: src/commands/theme/build.ts

f1 theme:watch

[DEPRECATED] run gesso-related watch tasks

USAGE
  $ f1 theme:watch

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  print command information prior to execution
  --css          watch CSS
  --dry-run      print command instead of running it
  --pattern-lab  watch PL

See code: src/commands/theme/watch.ts

f1 up

start a project up

USAGE
  $ f1 up

OPTIONS
  -f, --foreground  run compose in the foreground
  -h, --help        show CLI help
  -v, --verbose     print command information prior to execution
  --dry-run         print command instead of running it
  --xdebug          enable xdebug in the container

  --xdebug-profile  Enables the triggering of xdebug's profiler. See https://xdebug.org/docs/profiler for how to trigger
                    these requests.

See code: src/commands/up.ts

f1 wp

run wp-cli commands

USAGE
  $ f1 wp

OPTIONS
  -h, --help     show CLI help
                 Putting "--" at the end of your command, then adding additional flags (like --help) will run that flag
                 on the native command

  -v, --verbose  print command information prior to execution

  --dry-run      print command instead of running it

See code: src/commands/wp.ts