# nlxcli > CLI of NilexCMS - NilexCLI Latest version **0.2.1** (published 2022-04-09) · MIT license · 0 weekly downloads ## Install ```sh npm install nlxcli pnpm add nlxcli yarn add nlxcli bun add nlxcli ``` Provides the command `nlx`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.1 | | Published | 2022-04-09 | | First published | 2022-04-02 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=12.0.0 | | Dependencies | 17 | | Unpacked size | 463.4 KB | | Known vulnerabilities | 0 (+24 in 2 direct dependencies) | | Install scripts | no | | Author | Tewolde H Mekonen | | Maintainers | nilex | | Keywords | oclif | ## Links - npm: https://www.npmjs.com/package/nlxcli - Repository: https://github.com/nilex/nlxcli - Issues: https://github.com/nilex/nlxcli/issues - npm.io page: https://npm.io/package/nlxcli ## Dependencies (17) - [fs](https://npm.io/package/fs.md) 0.0.1-security - [ejs](https://npm.io/package/ejs.md) ^3.1.5 - [ora](https://npm.io/package/ora.md) ^5.1.0 - [path](https://npm.io/package/path.md) ^0.12.7 - [axios](https://npm.io/package/axios.md) ^0.21.1 - [chalk](https://npm.io/package/chalk.md) ^4.1.0 - [execa](https://npm.io/package/execa.md) ^4.1.0 - [gitly](https://npm.io/package/gitly.md) ^2.1.1 - [listr](https://npm.io/package/listr.md) ^0.14.3 - [semver](https://npm.io/package/semver.md) ^7.3.5 - [fs-sync](https://npm.io/package/fs-sync.md) ^1.0.6 - [shelljs](https://npm.io/package/shelljs.md) ^0.8.4 - [inquirer](https://npm.io/package/inquirer.md) ^7.3.3 - [dateformat](https://npm.io/package/dateformat.md) ^4.0.0 - [@oclif/core](https://npm.io/package/@oclif/core.md) ^1 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5 - [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.0.1 ## 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.2.1 (latest) — 2022-04-09 - 0.2.0 — 2022-04-09 - 0.1.2 — 2022-04-03 - 0.1.1 — 2022-04-03 - 0.1.0 — 2022-04-02 ## README oclif-hello-world ================= oclif example Hello World CLI [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world) [![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world) [![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ npm install -g nlxcli $ nlx COMMAND running command... $ nlx (--version) nlxcli/0.2.1 darwin-x64 node-v16.14.0 $ nlx --help [COMMAND] USAGE $ nlx COMMAND ... ``` # Commands * [`nlx cms [FILE]`](#nlx-cms-file) * [`nlx cms auth`](#nlx-cms-auth) * [`nlx cms crud`](#nlx-cms-crud) * [`nlx cms install [PROJECT_NAME]`](#nlx-cms-install-project_name) * [`nlx cms m`](#nlx-cms-m) * [`nlx cms m-crud`](#nlx-cms-m-crud) * [`nlx cms m-make TYPE MODULE NAME`](#nlx-cms-m-make-type-module-name) * [`nlx cms t`](#nlx-cms-t) * [`nlx cms t-make TYPE THEME NAME`](#nlx-cms-t-make-type-theme-name) * [`nlx hello PERSON`](#nlx-hello-person) * [`nlx hello world`](#nlx-hello-world) * [`nlx help [COMMAND]`](#nlx-help-command) * [`nlx plugins`](#nlx-plugins) * [`nlx plugins:install PLUGIN...`](#nlx-pluginsinstall-plugin) * [`nlx plugins:inspect PLUGIN...`](#nlx-pluginsinspect-plugin) * [`nlx plugins:install PLUGIN...`](#nlx-pluginsinstall-plugin-1) * [`nlx plugins:link PLUGIN`](#nlx-pluginslink-plugin) * [`nlx plugins:uninstall PLUGIN...`](#nlx-pluginsuninstall-plugin) * [`nlx plugins:uninstall PLUGIN...`](#nlx-pluginsuninstall-plugin-1) * [`nlx plugins:uninstall PLUGIN...`](#nlx-pluginsuninstall-plugin-2) * [`nlx plugins update`](#nlx-plugins-update) ## `nlx cms [FILE]` describe the command here ``` USAGE $ nlx cms [FILE] [-n ] [-f] FLAGS -f, --force -n, --name= name to print DESCRIPTION describe the command here EXAMPLES $ nlx cms ``` _See code: [src/commands/cms.ts](https://github.com/nilex/nlxcli/blob/v0.2.1/src/commands/cms.ts)_ ## `nlx cms auth` Generate CRUD operations for NlxCMS ``` USAGE $ nlx cms auth [--help] FLAGS --help Generate Auth operation for NlxCMS Themes DESCRIPTION Generate CRUD operations for NlxCMS ``` ## `nlx cms crud` Generate CRUD operations for NlxCMS ``` USAGE $ nlx cms crud [--help] FLAGS --help Generate CRUD operation for NlxCMS DESCRIPTION Generate CRUD operations for NlxCMS ``` ## `nlx cms install [PROJECT_NAME]` Install NlxCMS ``` USAGE $ nlx cms install [PROJECT_NAME] [--here] [-h] ARGUMENTS PROJECT_NAME [default: nlxcms] Enter the project folder name FLAGS -h, --help Show CLI help. --here If you want to install NlxCMS in current directory DESCRIPTION Install NlxCMS ``` ## `nlx cms m` To generate module for NlxCMS ``` USAGE $ nlx cms m [-h] [-n] [-f] FLAGS -f, --force -h, --help Show CLI help. -n, --name Show CLI help. DESCRIPTION To generate module for NlxCMS ``` ## `nlx cms m-crud` To generate CRUD operations for NlxCMS Module ``` USAGE $ nlx cms m-crud [-h] [-n] [-f] FLAGS -f, --force -h, --help Show CLI help. -n, --name Show CLI help. DESCRIPTION To generate CRUD operations for NlxCMS Module ``` ## `nlx cms m-make TYPE MODULE NAME` Generate for NlxCMS Module ``` USAGE $ nlx cms m-make [TYPE] [MODULE] [NAME] [-f] [-b] [-h] [-n] FLAGS -b, --backend -f, --frontend -h, --help Show CLI help. -n, --name Show CLI help. DESCRIPTION Generate for NlxCMS Module ``` ## `nlx cms t` To generate theme for NlxCMS ``` USAGE $ nlx cms t [-h] [-n] [-f] FLAGS -f, --force -h, --help Show CLI help. -n, --name Show CLI help. DESCRIPTION To generate theme for NlxCMS ``` ## `nlx cms t-make TYPE THEME NAME` Generate for NlxCMS Theme ``` USAGE $ nlx cms t-make [TYPE] [THEME] [NAME] [-f] [-b] [-h] [-n] FLAGS -b, --backend -f, --frontend -h, --help Show CLI help. -n, --name Show CLI help. DESCRIPTION Generate for NlxCMS Theme ``` ## `nlx hello PERSON` Say hello ``` USAGE $ nlx hello [PERSON] -f ARGUMENTS PERSON Person to say hello to FLAGS -f, --from= (required) Whom is saying hello DESCRIPTION Say hello EXAMPLES $ oex hello friend --from oclif hello friend from oclif! (./src/commands/hello/index.ts) ``` _See code: [src/commands/hello/index.ts](https://github.com/nilex/nlxcli/blob/v0.2.1/src/commands/hello/index.ts)_ ## `nlx hello world` Say hello world ``` USAGE $ nlx hello world DESCRIPTION Say hello world EXAMPLES $ oex hello world hello world! (./src/commands/hello/world.ts) ``` ## `nlx help [COMMAND]` Display help for nlx. ``` USAGE $ nlx help [COMMAND] [-n] ARGUMENTS COMMAND Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for nlx. ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_ ## `nlx plugins` List installed plugins. ``` USAGE $ nlx plugins [--core] FLAGS --core Show core plugins. DESCRIPTION List installed plugins. EXAMPLES $ nlx plugins ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_ ## `nlx plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ nlx plugins:install PLUGIN... ARGUMENTS PLUGIN Plugin to install. FLAGS -f, --force Run yarn install with force flag. -h, --help Show CLI help. -v, --verbose DESCRIPTION Installs a plugin into the CLI. Can be installed from npm or a git url. Installation of a user-installed plugin will override a core plugin. e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. ALIASES $ nlx plugins add EXAMPLES $ nlx plugins:install myplugin $ nlx plugins:install https://github.com/someuser/someplugin $ nlx plugins:install someuser/someplugin ``` ## `nlx plugins:inspect PLUGIN...` Displays installation properties of a plugin. ``` USAGE $ nlx plugins:inspect PLUGIN... ARGUMENTS PLUGIN [default: .] Plugin to inspect. FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Displays installation properties of a plugin. EXAMPLES $ nlx plugins:inspect myplugin ``` ## `nlx plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ nlx plugins:install PLUGIN... ARGUMENTS PLUGIN Plugin to install. FLAGS -f, --force Run yarn install with force flag. -h, --help Show CLI help. -v, --verbose DESCRIPTION Installs a plugin into the CLI. Can be installed from npm or a git url. Installation of a user-installed plugin will override a core plugin. e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. ALIASES $ nlx plugins add EXAMPLES $ nlx plugins:install myplugin $ nlx plugins:install https://github.com/someuser/someplugin $ nlx plugins:install someuser/someplugin ``` ## `nlx plugins:link PLUGIN` Links a plugin into the CLI for development. ``` USAGE $ nlx plugins:link PLUGIN ARGUMENTS PATH [default: .] path to plugin FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Links a plugin into the CLI for development. Installation of a linked plugin will override a user-installed or core plugin. e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work. EXAMPLES $ nlx plugins:link myplugin ``` ## `nlx plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ nlx plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ nlx plugins unlink $ nlx plugins remove ``` ## `nlx plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ nlx plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ nlx plugins unlink $ nlx plugins remove ``` ## `nlx plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ nlx plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ nlx plugins unlink $ nlx plugins remove ``` ## `nlx plugins update` Update installed plugins. ``` USAGE $ nlx plugins update [-h] [-v] FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Update installed plugins. ``` --- _Source: https://npm.io/package/nlxcli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._