@nexus-ioc/cli

@nexus-ioc/cli

@nexus-ioc/cli is a command-line interface (CLI) tool for working with the Nexus IoC library. It helps developers create services, modules, and other components, simplifying the development and setup process.

Installation

Global Installation

You can install the CLI globally using npm:

npm install -g @nexus-ioc/cli

Using with npx

You can also use the CLI without global installation using npx:

npx @nexus-ioc/cli <command> [options]

Commands

generate (or g)

Generates a new component, such as a service or module.

Syntax

nexus-cli generate <type> <name> [path]

or the shorthand form:

nexus-cli g <type> <name> [path]

• <type>: The type of component to generate (e.g., service, module).
• <name>: The name of the new component.
• [path]: (Optional) The path where the new component will be created.

Examples

Creating a new auth service in the ./apps/auth folder:

nexus-cli generate service auth ./apps/auth

or

nexus-cli g service auth ./apps/auth

Creating a new user module in the current directory:

nexus-cli generate module user

install (or i)

Installs the Nexus IoC package.

Syntax

nexus-cli install

or the shorthand form:

nexus-cli i

Installs @nexus-ioc/core in your project.

Example

nexus-cli install

Options

• --help: Shows help for using the command.
• --version: Shows the CLI version.

Usage Examples

• Check the CLI version:

  nexus-cli --version
  

• Get help for the generate command:

  nexus-cli generate --help
  

• Generate a new service:

  nexus-cli g service auth ./apps/auth
  

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Isqanderm (Aleksandr Melnik) - LinkedIn

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Acknowledgements

Special thanks to the developers of Angular and NestJS for the inspiration.

Wiki

For more detailed documentation, please visit the Wiki.