# @amberjs/cli > Amber.js command line interface Latest version **0.0.4** (published 2019-10-23) · MIT license · 0 weekly downloads ## Install ```sh npm install @amberjs/cli pnpm add @amberjs/cli yarn add @amberjs/cli bun add @amberjs/cli ``` Provides the command `amber`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.4 | | Published | 2019-10-23 | | First published | 2019-10-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 15 | | Unpacked size | 101.1 KB | | Known vulnerabilities | 0 (+8 in 2 direct dependencies) | | Install scripts | no | | Author | brewers@stratpoint.com | | Maintainers | brewery-apps, excelsior.mante, jcalado | | Keywords | thebrewery, amberjs, cli, generators | ## Links - npm: https://www.npmjs.com/package/@amberjs/cli - Repository: https://gitlab.stratpoint.dev/thebrewery/amberjs/cli - npm.io page: https://npm.io/package/@amberjs/cli ## Dependencies (15) - [mv](https://npm.io/package/mv.md) ^2.1.1 - [ora](https://npm.io/package/ora.md) ^4.0.1 - [chalk](https://npm.io/package/chalk.md) ^2.4.2 - [dotenv](https://npm.io/package/dotenv.md) ^8.1.0 - [yamljs](https://npm.io/package/yamljs.md) ^0.3.0 - [inquirer](https://npm.io/package/inquirer.md) ^7.0.0 - [commander](https://npm.io/package/commander.md) ^3.0.1 - [sequelize](https://npm.io/package/sequelize.md) ^5.19.0 - [decompress](https://npm.io/package/decompress.md) ^4.2.0 - [inflection](https://npm.io/package/inflection.md) ^1.12.0 - [sequelize-cli](https://npm.io/package/sequelize-cli.md) ^5.5.1 - [command-exists](https://npm.io/package/command-exists.md) ^1.2.8 - [decompress-targz](https://npm.io/package/decompress-targz.md) ^4.1.1 - [swagger-sequelize](https://npm.io/package/swagger-sequelize.md) ^0.1.3 - [graphql-to-json-schema](https://npm.io/package/graphql-to-json-schema.md) ^1.0.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 0.0.4 (latest) — 2019-10-23 - 0.0.3 — 2019-10-23 - 0.0.2 — 2019-10-16 - 0.0.1 — 2019-10-13 ## README # @amberjs/cli Amber.js CLI tool. Code generators for Amber.js Framework. ## Table of Contents * [Usage](#usage) * [Development](#development) * [Prerequisites](#prerequisites) * [Build](#Build) * [Contributors](#contributors) * [License](#license) ## Usage This CLI tools is a helper for Amber.js Framework. It eases development workflow by generating codes and templates for Amber.js Framework. You must be in the root directory of an Amber.js project generated using [@brewery/cli](https://gitlab.stratpoint.dev/thebrewery/brewery-cli). ``` Amber.js CLI v0.0.1 Commands: graphql:deploy deploy resolver server using defined SDL scaffold scaffold infra, interface and domain based on swagger schema create:domain create domain base template create:appservice create app service base template create:datasource create datasource wizard create:repository create repository command create:model create model command create:apiresource create apiresource command ``` ## Development Creating commands: Example command configuration: Single command in one JSON file: ```json { "command": "command ", "description": "command description", "usage": "command arg1 --option=value ", "options": { "option1": { "description": "option1 description", "default" : true, "value": "required" }, "option2": { "description": "option2 description" }, "option3": { "description": "option3 description" } }, "execPath": "./actions/command/" } ``` Multiple commands in one JSON file: ```json [ { "command": "namespace:command1 ", "description": "namespace:command1 description", "usage": "namespace:command1 --options=value ", "options": { "option1": { "description": "option1 description", "default" : true, "value": "required" }, "option2": { "description": "option2 description" }, "option3": { "description": "option3 description" } }, "execPath": "./actions/namespace/" }, { "command": "namespace:command2", "description": "namespace:command2 description", "usage": "namespace:command2 --options", "options": { "option1": { "description": "option1 description", "default" : true, "value": "required" }, "option2": { "description": "option2 description" }, "option3": { "description": "option3 description" } }, "execPath": "./actions/namespace/" } ] ``` To create commands for CLI, create new json file on ```src/configs/your_command.json```. The config json will automatically be loaded by the CLI. - ```command```: Name of the command. Expected arguments for the command should be enclosed in "```< >```" eg. ```""```, if an argument is required it should be enclosed in ```""``` eg. ```""``` - ```description```: description of the command - ```usage```: example usage of the command - ```options```: available options for the command - ```default```: set to true if option should be enabled by default. - ```value```: set to required if a value for the option is required. - ```execPath```: should contain the path to the script that will perform the action of your command, you may place your scripts on src/actions for uniformity - your ```execPath``` should return a function that requires 3 parameters for (config , command, args) Example script for command action considering the following input from the CLI ```sh binaryname samplecommand argValue --option1=value ``` ```js const commandAction = (config, command, args) => { console.log(config); // contains config of your command loaded from the JSON file /* { "command": "samplecommand ", "description": "samplecommand description", "usage": "samplecommand --options=value ", "options": { "option1": { "description": "option1 description", "default" : true, "value": "required" }, "option2": { "description": "option2 description" }, "option3": { "description": "option3 description" } }, "execPath": "./actions/samplecommand/" }, */ console.log(command); // contains organized data based on parsed input from cli /* { name: samplecommand args: { arg1: "argValue", arg2: null } options: { "option1": { value: "value" }, "option2": null, "option3": null } } */ console.log(args) // contains array of raw arguments inputted on the cli // ['binaryname', 'samplecommand', 'argValue', '--option1=value'] // Perform the action for your command ... } module.exports = commandAction; ``` ## Prerequisites Install ```pkg``` for creating executable files ```sh npm install -g pkg ``` ## Build To build executable file for all platforms (Windows, Linux, Macos) run: ```sh npm run build ``` or ```sh pkg package.json ``` this will create the executable files on project root directory ## Contributors * Joshua Elijah Mante * Ronald dela Cruz * James Levin Calado * brewers@stratpoint.com ## License [MIT](LICENSE) © Stratpoint Technologies Inc. --- _Source: https://npm.io/package/@amberjs/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._