grapi-cli

{ "commands": { "app": { "aliases": [], "args": { "name": { "description": "name of the application.", "name": "name" } }, "description": "generate application.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "name": { "description": "Application class name.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "description": "Description of the application.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "outdir": { "description": "Project root directory for the application.", "name": "outdir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "eslint": { "description": "Add ESLint to LoopBack4 application project.", "name": "eslint", "allowNo": false, "type": "boolean" }, "prettier": { "description": "Add Prettier to LoopBack4 application project.", "name": "prettier", "allowNo": false, "type": "boolean" }, "mocha": { "description": "Add Mocha to LoopBack4 application project.", "name": "mocha", "allowNo": false, "type": "boolean" }, "loopbackBuild": { "description": "Add @loopback/build module’s script set to LoopBack4 application project.", "name": "loopbackBuild", "allowNo": false, "type": "boolean" }, "vscode": { "description": "Add VSCode config files to LoopBack4 application project", "name": "vscode", "allowNo": false, "type": "boolean" }, "docker": { "description": "Generate Dockerfile and add npm scripts to build/run the project in a docker container.", "name": "docker", "allowNo": false, "type": "boolean" }, "repositories": { "description": "include repository imports and RepositoryMixin.", "name": "repositories", "allowNo": false, "type": "boolean" }, "services": { "description": "include service-proxy imports and ServiceMixin.", "name": "services", "allowNo": false, "type": "boolean" }, "controllerDirs": { "description": "a comma seperated list of directory names to use as controller directories.", "name": "controllerDirs", "allowNo": false, "type": "boolean" }, "apiconnect": { "description": "Include ApiConnectComponent.", "name": "apiconnect", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "app.js" ] }, "audit": { "aliases": [], "args": { "name": { "description": "name of the datasource.", "name": "name" } }, "description": "generate audit artifacts.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "connector": { "description": "Name of datasource connector.", "name": "connector", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "audit", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "audit.js" ] }, "auth": { "aliases": [], "args": {}, "description": "adding auth to loopback 4 application.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include": { "char": "i", "description": "include auth to the apis.", "name": "include", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude": { "char": "e", "description": "exclude auth to the apis.", "name": "exclude", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "writeonly": { "char": "r", "description": "auth to writeonly apis.", "name": "writeonly", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datasource": { "description": "name of the datasource.", "name": "datasource", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "auth.js" ] }, "authorization": { "aliases": [], "args": {}, "description": "add authorization layer.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datasrouce": { "description": "name of the datasource.", "name": "datasrouce", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "authorization", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "authorization.js" ] }, "cache": { "aliases": [], "args": {}, "description": "creating cache for endpoints", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "redisDS": { "description": "redisDS", "name": "redisDS", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cacheTTL": { "description": "cacheTTL", "name": "cacheTTL", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "prefix": { "description": "prefix to append to endpoints.", "name": "prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude": { "description": "exclude controllers", "name": "exclude", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include": { "description": "include controllers", "name": "include", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cache", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "cache.js" ] }, "controller": { "aliases": [], "args": { "name": { "description": "name of controller.", "name": "name" } }, "description": "generate controllers", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "controllerType": { "description": " Type of the controller. Valid types are BASIC and REST. BASIC corresponds to an empty controller, whereas REST corresponds to REST controller with CRUD methods.", "name": "controllerType", "hasDynamicHelp": false, "multiple": false, "options": [ "REST", "BASIC" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "controller", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "controller.js" ] }, "copyright": { "aliases": [], "args": {}, "description": "add/update copyright", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "owner": { "description": "The owner of the copyright, such as IBM Corp. and LoopBack contributors.", "name": "owner", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "license": { "description": "The name of the license, such as MIT.", "name": "license", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "gitOnly": { "description": " A flag to control if only git tracked files are updated. Default to true.", "name": "gitOnly", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "updateLicense": { "description": "A flag to control if package.json and LICENSE files should be updated to reflect the selected license id.", "name": "updateLicense", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude": { "description": "One or more glob patterns with , delimiter to exclude files that match the patterns from being updated.", "name": "exclude", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "copyright", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "copyright.js" ] }, "datasource": { "aliases": [], "args": { "name": { "description": "name of the datasource.", "name": "name" } }, "description": "generate datasource.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "connector": { "description": "Name of datasource connector.", "name": "connector", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "datasource", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "datasource.js" ] }, "discover": { "aliases": [], "args": { "url": { "description": "URL or file path of the OpenAPI spec. Type: String. Required: false.", "name": "url" } }, "description": "discover models.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "dataSource": { "description": "Put a valid datasource name here to skip the datasource prompt.", "name": "dataSource", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "views": { "description": "Choose whether to discover views.", "name": "views", "allowNo": false, "type": "boolean" }, "relations": { "description": "Choose whether to create relations.", "name": "relations", "allowNo": false, "type": "boolean" }, "all": { "description": "Skips the model prompt and discovers all of them.", "name": "all", "allowNo": false, "type": "boolean" }, "outDir": { "description": "Specify the directory into which the model.model.ts files will be placed. Default is src/models.", "name": "outDir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "schema": { "description": "Specify the schema which the datasource will find the models to discover.", "name": "schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "models": { "description": "Specify the models to be generated e.g:–models=table1,table2.", "name": "models", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "optionalId": { "description": "Specify if the Id property of generated models will be marked as not required.", "name": "optionalId", "allowNo": false, "type": "boolean" }, "connectorDiscoveryOptions": { "description": "Pass the options to the connectors.", "name": "connectorDiscoveryOptions", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "discover", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "discover.js" ] }, "example": { "aliases": [], "args": { "example-name": { "description": "Optional name of the example to clone. If provided, the tool will skip the example-name prompt and run in a non-interactive mode.", "name": "example-name" } }, "description": "download examples.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "example", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "example.js" ] }, "extension": { "aliases": [], "args": { "name": { "description": "Optional name of the extension given as an argument to the command.", "name": "name" } }, "description": "generate extension.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "description": { "description": "project root directory for the extension.", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "outDir": { "description": "Project root directory for the extension.", "name": "outDir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "eslint": { "description": "Add ESLint to LoopBack4 extension project.", "name": "eslint", "allowNo": false, "type": "boolean" }, "prettier": { "description": "Add Prettier to LoopBack4 extension project.", "name": "prettier", "allowNo": false, "type": "boolean" }, "mocha": { "description": "Add Mocha to LoopBack4 extension projectAdd @loopback/build module’s script set to LoopBack4 extension project.", "name": "mocha", "allowNo": false, "type": "boolean" }, "loopbackBuild": { "description": "Add @loopback/build module’s script set to LoopBack4 extension project.", "name": "loopbackBuild", "allowNo": false, "type": "boolean" }, "vscode": { "description": "Add VSCode config files to LoopBack4 application project.", "name": "vscode", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "extension", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "extension.js" ] }, "fuzzy": { "aliases": [], "args": {}, "description": "generate fuzzy endpoints for lb4 based controllers", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fuzzy": { "description": "fuzzy", "name": "fuzzy", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "centralFuzzy": { "description": "central Fuzzy", "name": "centralFuzzy", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "datasource": { "description": "datasource name", "name": "datasource", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "appName": { "description": "name of the application", "name": "appName", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude": { "description": "exclude controllers", "name": "exclude", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include": { "description": "include controllers", "name": "include", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fuzzy", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "fuzzy.js" ] }, "import-lb3-models": { "aliases": [], "args": { "lb3app": { "description": "Path to the directory containing your LoopBack 3.x application.", "name": "lb3app" } }, "description": "import lb3 models.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "outDir": { "description": "Directory where to write the generated source file. Default: src/models.", "name": "outDir", "default": "src/models", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import-lb3-models", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "import-lb3-models.js" ] }, "interceptor": { "aliases": [], "args": { "name": { "description": "Required name of the observer to create as an argument to the command.", "name": "name", "required": true } }, "description": "generate interceptor.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "global": { "description": "Optional flag to indicate a global interceptor (default to true). Use --no-global to set it to false.", "name": "global", "allowNo": false, "type": "boolean" }, "no-global": { "description": "set global to false", "name": "no-global", "allowNo": false, "type": "boolean" }, "group": { "description": "Optional name of the interceptor group to sort the execution of global interceptors by group. This option is only supported for global interceptors.", "name": "group", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "interceptor", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "interceptor.js" ] }, "model": { "aliases": [], "args": { "name": { "description": "name of the model.", "name": "name" } }, "description": "generate model.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "base": { "description": "a valid model already created in src/models or any of the core based class models Entity or Model. Your new model will extend this selected base model class", "name": "base", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dataSource": { "description": "The name of the dataSource which contains this model and suppots model discovery", "name": "dataSource", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "table": { "description": "If discovering a model from a dataSource, specify the name of its table/view", "name": "table", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "schema": { "description": "If discovering a model from a dataSource, specify the schema which contains it", "name": "schema", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "model", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "model.js" ] }, "observer": { "aliases": [], "args": { "name": { "description": "Required name of the observer to create as an argument to the command.", "name": "name", "required": true } }, "description": "generate observer.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "group": { "description": "Optional name of the observer group to sort the execution of observers by group.", "name": "group", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "observer", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "observer.js" ] }, "openapi": { "aliases": [], "args": { "url": { "description": "URL or file path of the OpenAPI spec. Type: String. Required: false.", "name": "url" } }, "description": "generate openapi based apis.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-configs", "allowNo": false, "type": "boolean" }, "url": { "description": "URL or file path of the OpenAPI spec.", "name": "url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "validate": { "description": "Validate the OpenAPI spec.", "name": "validate", "allowNo": false, "type": "boolean" }, "promote-anonymous-schemas": { "description": "Promote anonymous schemas as models classes.", "name": "promote-anonymous-schemas", "allowNo": false, "type": "boolean" }, "client": { "description": "Generate client-side service proxies and controllers with implementation for the OpenAPI spec.", "name": "client", "allowNo": false, "type": "boolean" }, "datasource": { "description": "A valid datasource name.", "name": "datasource", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "redisDS": { "description": "Stringified object of redis DS configs.", "name": "redisDS", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cache": { "description": "Stringified object of cache configs.", "name": "cache", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "positional": { "description": "A flag to control if service methods use positional parameters or an object with named properties.", "name": "positional", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "openapi", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "openapi.js" ] }, "patch": { "aliases": [], "args": {}, "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "patches": { "description": "An stringified array of patches.", "name": "patches", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "patch", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "patch.js" ] }, "post-ds-patches": { "aliases": [], "args": {}, "description": "execute post ds patches.", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "post-ds-patches", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "post-ds-patches.js" ] }, "post-patches": { "aliases": [], "args": {}, "description": "execute post patches.", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "post-patches", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "post-patches.js" ] }, "pre-patches": { "aliases": [], "args": {}, "description": "execute pre patches.", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "pre-patches", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "pre-patches.js" ] }, "pre-relation-patches": { "aliases": [], "args": {}, "description": "execute pre relation patches.", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "pre-relation-patches", "pluginAlias": "grapi-cli", "pluginName": "grapi-cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "pre-relation-patches.js" ] }, "relation": { "aliases": [], "args": {}, "description": "generate relations.", "flags": { "config": { "char": "c", "description": "Config JSON object", "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "description": "Skip all confirmation prompts with default or provided value.", "name": "yes", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Print the generator’s options and usage.", "name": "help", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force to overwrite files.", "name": "force", "allowNo": false, "type": "boolean" }, "skip-cache": { "description": "Do not remember prompt answers. Default is false.", "name": "skip-cache", "allowNo": false, "type": "boolean" }, "skip-install": { "description": "Do not automatically install dependencies. Default is false.", "name": "skip-install", "allowNo": false, "type": "boolean" }, "generate-configs": { "description": "return configs based on answers from the prompt.", "name": "generate-con