Skip to content

Zenaura CLI Guide

The Zenaura CLI tool simplifies the process of creating, building, and running Zenaura projects. This guide will walk you through the basic commands and functionalities provided by the Zenaura CLI.

Installation

Zenaura cli comes out of the box with zenaura framework:

pip install zenaura

CLI Commands

The Zenaura CLI provides three main commands: init, build, and run.

init

The init command sets up a new Zenaura project with the necessary structure and files.

zenaura init

This command creates a public directory with initial files and folders, including:

  • public/main.py : where main project code lives
  • public/config.json : configuration for pyscript
  • public/index.html : root html.
  • main.css : main css.
  • public/__init__.py : where you import other components used inside the project in any directory.

It also creates two additional files in the project root:

  • build.py
  • index.py

build

The build command runs the build.py script to prepare your project for deployment.

zenaura build

run

The run command starts the development server using the index.py script.

zenaura run

Example Workflow

Here is an example of a typical workflow using the Zenaura CLI:

  1. Initialize a new project:
zenaura init
  1. Build the project:
zenaura build
  1. Run the project: 
    zenaura run

Notes

  • Hot-reloading: The hot-reloading feature is currently under development. To ensure your changes are reflected in the browser, use the build command before running the project.
  • Python Versions: Ensure you are using a compatible Python version with Zenaura and the required packages.

By following this guide, you can efficiently manage your Zenaura projects using the CLI tool. Enjoy building dynamic and interactive UIs with Zenaura!