Zanix Framework CLI

Table of Contents

• Introduction
• Installation
• Usage
• Getting Started
• Support and Contributions
• License
• Authors

Introduction

The Zanix Framework CLI is a powerful command-line interface (CLI) tool designed to facilitate the development and management of Zanix applications. With a comprehensive set of commands and utilities, the CLI empowers developers to streamline their workflow and efficiently work with ZanixJS projects. This README provides an overview of the CLI commands and their usage.

Installation

To install the Zanix Framework CLI globally, use the following command:

npm install -g @zanix/cli

Usage

The Zanix Framework CLI provides a range of commands to help you with various tasks related to ZanixJS development. Here are the available commands:

zjs help

Display the help information and a list of available commands.

zjs prepare

Prepare a ZanixJS application by configuring husky, lintstaged, and other initial requirements.

zjs test [options]

Run unit tests for a ZanixJS application using Jest.

zjs build [options]

Compile TypeScript code to JavaScript. By default, it generates TypeScript definitions in one file. Use the --no-otf option to generate in multiple types, --no-obfuscate-statics to disable public js files obfuscation, and --no-obfuscate to disable main distributed file obfuscation.

zjs deploy [options]

Publish a ZanixJS application. This command is currently under construction and will handle tasks such as containerization and CI/CD workflows.

zjs start [options] [script]

Run a ZanixJS application in production mode. Optionally, provide a main script to start the application. Logs can be saved in the distribution by default, or use the --no-save-logs option to disable log saving.

zjs dev [options] [script]

Run a ZanixJS application in development mode using Nodemon for automatic restarts. Optionally, provide a main script to start the application. The development mode is enabled by default, but you can use the --no-watch option to disable watching.

zjs format

Format ZanixJS code using Prettier.

zjs lint

Fix linting issues in ZanixJS code using ESLint.

zjs new <component>

Generate a new ZanixJS component. Use the api command to generate a new API. The component argument specifies the name of the new component.

zjs new api [options] [path]

Generate a new API with customizable options. The path argument specifies the folder path for the new API. By default, both GraphQL and REST APIs are generated. Use the --no-gql or --no-rest options to exclude generating either the GraphQL or REST API. This is generated with the api-base ZANIX Framework Template.

Getting Started

To start using the Zanix Framework CLI, make sure it is installed globally on your system. Refer to the installation section above.

Once installed, you can run any of the CLI commands listed above by executing zjs <command> in your terminal.

For example, to display help information and a list of available commands, run:

zjs help

Explore the various commands provided by the CLI to enhance your ZanixJS development experience.

Support and Contributions

For more information on how to use the templates and get started with ZANIX CLI, please refer to the documentation or to the changelog.

If you have any questions, suggestions, or feedback, you can reach out to the author via email at [email protected]. You can also connect with the author on Linkedin for updates and announcements about software.

License

The Zanix Server CLI is an open-source project released under the MIT License.

Authors ✨

• Ismael Calle Marulanda @iscam2216