https://github.com/nagyv/c3-addon-cli
A set of commands to manage Construct 3 addon development
https://github.com/nagyv/c3-addon-cli
boilerplate construct3 oclif sao
Last synced: 14 days ago
JSON representation
A set of commands to manage Construct 3 addon development
- Host: GitHub
- URL: https://github.com/nagyv/c3-addon-cli
- Owner: nagyv
- License: mit
- Created: 2019-03-13T19:37:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-14T21:57:55.000Z (almost 7 years ago)
- Last Synced: 2025-02-08T10:13:00.544Z (about 1 year ago)
- Topics: boilerplate, construct3, oclif, sao
- Language: JavaScript
- Size: 175 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Construct 3 Addon CLI
======================
A set of commands to manage Construct 3 addon development
[](https://oclif.io)
[](https://npmjs.org/package/c3-addon-cli)
[](https://npmjs.org/package/c3-addon-cli)
[](https://github.com/nagyv/c3-addon-cli/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
* [Plans](#plans)
* [License](#license)
# Usage
You can use this addon as an npx script too. e.g. `npx c3-addon-cli addAction myShinyAction`
```sh-session
$ npm install -g c3-addon-cli
$ c3-addon-cli COMMAND
running command...
$ c3-addon-cli (-v|--version|version)
c3-addon-cli/1.2.0 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-addaction-id)
* [`c3-addon-cli addCondition ID`](#c3-addon-cli-addcondition-id)
* [`c3-addon-cli addExpression ID`](#c3-addon-cli-addexpression-id)
* [`c3-addon-cli help [COMMAND]`](#c3-addon-cli-help-command)
* [`c3-addon-cli init OUTDIR`](#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](https://github.com/nagyv/c3-addon-cli/blob/v1.2.0/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](https://github.com/nagyv/c3-addon-cli/blob/v1.2.0/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](https://github.com/nagyv/c3-addon-cli/blob/v1.2.0/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](https://github.com/oclif/plugin-help/blob/v2.1.6/src\commands\help.ts)_
## `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](https://github.com/nagyv/c3-addon-cli/blob/v1.2.0/src\commands\init.js)_
# Plans
1. Provide the cli functionality for behaviors and effects too
# License
MIT license. See LICENCE.md