next-js-cli v1.0.1
cli - Next Command Line Interface
Next js r CLI is a command-line interface tool that you use to initialize, develop, scaffold,
Summary
ncli - Next cli
Installing Next CLI
Install the CLI using the npm package manager:
npm install --global next-js-clior
npm install -g next-js-cliBasic Workflow
Invoke the tool on the command line through the ncli executable. Online help is available on the command line. Enter the following to list commands or options for a given command (such as generate) with a short description.
ncli help
ncli generate --helpWorkspace and project files
the ncli only works inside a nextjs folder or a next js workspace. So this means that the commands in command-overview nust be executed inside the next js project directory.
Use the ncli generate command to add new files for additional components, hooks, api routes and new pages.
CLI command-language syntax
Command syntax is shown as follows:
ncli <command> [command-params]Command Overview
| COMMAND | ALIAS | DESCRIPTION |
|---|---|---|
generate | g | Generates and/or modifies files based on a schematic. |
ncli generate
Generates files based on a schematic.
ncli generate <schematic> <name> [path] [ext]ncli g <schematic> <name> [path] [ext]This command has the following sub-commands:
- api
- component
- hook
- api
Generate Arguments
| ARGUMENT | DESCRIPTION | VALUE TYPE | VALUES | DEFAULT VALUE |
|---|---|---|---|---|
schematic | The collection:schematic to run. | string | ||
<name> | The name of the schematic item (hook name, api route name, and so on) | string | ||
[path] | The path where the schematic will be operated | string | . | |
[ext] | Represents the extension of the file (ts or js) | string | jsor ts |
Generate Options
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
|---|---|---|---|
--help | Shows a help message for this command in the console. | boolean | false |
Generate Commands
api
ncli generate api <name> [path] [ext]ncli generate a [path] [ext]Creates a new api route and his handler in the given or default project src/pages/api directory.
component
ncli generate component <name> [path] [ext]ncli generate c [path] [ext]Creates a new, generic component definition in the given or default project. src/compoents directory
hook
ncli generate hook <name> [path] [ext]ncli generate h [path] [ext]Creates a new hook definition in the given or default project. src/hooks directory
page
ncli generate page <name> [path] [ext]ncli generate p [path] [ext]Creates a new page route and component in the given or default project src/pages directory.