@nimblehq/react-templates v1.0.0-alpha.2
Command Line Interface for React application at Nimble.
This CLI is built with the Open CLI framework
Usage
$ npm install -g @nimblehq/react-templates
$ nimble-react COMMAND
running command...
$ nimble-react (--version)
@nimblehq/react-templates/1.0.0-alpha.2 linux-x64 node-v16.16.0
$ nimble-react --help [COMMAND]
USAGE
$ nimble-react COMMAND
...
Commands
nimble-react generate APPNAME [TEMPLATE]
nimble-react help [COMMAND]
nimble-react plugins
nimble-react plugins:install PLUGIN...
nimble-react plugins:inspect PLUGIN...
nimble-react plugins:install PLUGIN...
nimble-react plugins:link PLUGIN
nimble-react plugins:uninstall PLUGIN...
nimble-react plugins:uninstall PLUGIN...
nimble-react plugins:uninstall PLUGIN...
nimble-react plugins update
nimble-react generate APPNAME [TEMPLATE]
Generate Nimble React application
USAGE
$ nimble-react generate [APPNAME] [TEMPLATE]
ARGUMENTS
APPNAME application name
TEMPLATE [default: @nimblehq] template location, use "file:{../path/to/your/local/template/repo}" for using a local
cra template
DESCRIPTION
Generate Nimble React application
EXAMPLES
$ nimble-react generate app-name
See code: dist/commands/generate/index.ts
nimble-react help [COMMAND]
Display help for nimble-react.
USAGE
$ nimble-react 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 nimble-react.
See code: @oclif/plugin-help
nimble-react plugins
List installed plugins.
USAGE
$ nimble-react plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ nimble-react plugins
See code: @oclif/plugin-plugins
nimble-react plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ nimble-react 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
$ nimble-react plugins add
EXAMPLES
$ nimble-react plugins:install myplugin
$ nimble-react plugins:install https://github.com/someuser/someplugin
$ nimble-react plugins:install someuser/someplugin
nimble-react plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ nimble-react 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
$ nimble-react plugins:inspect myplugin
nimble-react plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ nimble-react 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
$ nimble-react plugins add
EXAMPLES
$ nimble-react plugins:install myplugin
$ nimble-react plugins:install https://github.com/someuser/someplugin
$ nimble-react plugins:install someuser/someplugin
nimble-react plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ nimble-react 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
$ nimble-react plugins:link myplugin
nimble-react plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nimble-react plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nimble-react plugins unlink
$ nimble-react plugins remove
nimble-react plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nimble-react plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nimble-react plugins unlink
$ nimble-react plugins remove
nimble-react plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nimble-react plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nimble-react plugins unlink
$ nimble-react plugins remove
nimble-react plugins update
Update installed plugins.
USAGE
$ nimble-react plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
How to contribute
To run the CLI on your local machine:
$ cd ./packages/cli-tool/
$ npm i
$ ./bin/dev generate app-name
💡 Running just
./bin/dev
without argument will display all the possible commands as well as additional information.
If your changes also impacted the cra-template
package, you can still test them locally using:
./bin/dev generate test-cli file:../cra-template
Find more the OCLIF Documentation!
License
This project is Copyright (c) 2014 and onwards. It is free software and may be redistributed under the terms specified in the LICENSE file.
About
This project is maintained and funded by Nimble.
We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.