Zodyac CLI

The CLI tool for creating and managing Zodyac projects.

Please refer to the Zodyac documentation for more information.

Warning

This version CLI is currently in beta and is not yet ready for production use. For now it supports only the creation of new projects, generation of modules, serving, building and watching.

Installation

npm install -g @zodyac/cli

Usage

zy --help

Commands

zy init

Initializes a new Zodyac project in the current directory. Generates a package.json file and installs the latest version of Zodyac.

Options:

• -p, --project <name>: The name of the project.
• -r, --router: Whether to generate a router module.
• --skip-eslint: Skips the installation of ESLint.
• --skip-git: Skips Git initialization.
• --skip-docker: Skips creating Dockerfile.

zy serve

Serves the current Zodyac project.

zy build

Builds the current Zodyac project.

zy watch

Watches the current Zodyac project for changes and checks for errors.

zy generate <type> <name>

Generates a new Zodyac module.

Options:

• type: The type of module to generate. Can be one of module, router, service, model or crud.
• name: The name of the module/router to generate.

Note: Only module and router are currently supported.

zy add <type>

Adds an extention to the current project. You can add:

• express: Adds Express.js API Engine.
• eslint: Adds ESLint and configuration.
• git: Initializes Git repository and .gitignore.
• docker: Creates Dockerfile and .dockerignore.

License

MIT