c3-addon-cli

Construct 3 Addon CLI

A set of commands to manage Construct 3 addon development

• Usage
• Commands
• Plans
• License

Usage

You can use this addon as an npx script too. e.g. npx c3-addon-cli addAction myShinyAction

$ npm install -g c3-addon-cli
$ c3-addon-cli COMMAND
running command...
$ c3-addon-cli (-v|--version|version)
c3-addon-cli/1.2.4 win32-x64 node-v10.15.0
$ c3-addon-cli --help [COMMAND]
USAGE
  $ c3-addon-cli COMMAND
...

Commands

• c3-addon-cli addAction ID
• c3-addon-cli addCondition ID
• c3-addon-cli addExpression ID
• c3-addon-cli help [COMMAND]
• c3-addon-cli init OUTDIR

c3-addon-cli addAction ID

Add new action

USAGE
  $ c3-addon-cli addAction ID

ARGUMENTS
  ID  An identifier for the action. This will be the scriptName too.

OPTIONS
  -h, --isHighlighted  Is highlighted
  --dryRun             Dry run. Don't write any changes to disk

See code: src\commands\addAction.js

c3-addon-cli addCondition ID

Add new condition

USAGE
  $ c3-addon-cli addCondition ID

ARGUMENTS
  ID  An identifier for the condition. This will be the scriptName too.

OPTIONS
  -h, --isHighlighted  Is highlighted
  -i, --isInvertible   Is invertible
  -t, --isTrigger      Is trigger
  --dryRun             Dry run. Don't write any changes to disk

See code: src\commands\addCondition.js

c3-addon-cli addExpression ID

Add new expression

USAGE
  $ c3-addon-cli addExpression ID

ARGUMENTS
  ID  An identifier for the expression. This will be the scriptName too.

OPTIONS
  --dryRun  Dry run. Don't write any changes to disk

See code: src\commands\addExpression.js

c3-addon-cli help [COMMAND]

display help for c3-addon-cli

USAGE
  $ c3-addon-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

c3-addon-cli init OUTDIR

Start a new C3 plugin

USAGE
  $ c3-addon-cli init OUTDIR

ARGUMENTS
  OUTDIR  The output directory for the new C3 plugin code

See code: src\commands\init.js

Plans

1. Provide the cli functionality for behaviors and effects too

License

MIT license. See LICENCE.md