Installation

ZhinNX can be installed in two ways: use the local source package while the project is not published yet, or install the public CLI after the npm release.

Before npm release: use the local CLI

When you download the ZIP or clone the GitHub repository, run the CLI from the zhinnx-cli directory.

cd zhinnx-cli
npm install --package-lock=false --no-audit --no-fund
node bin/zz.js --help
node bin/zz.js create my-app --template landing --vercel

If you want the zz command available locally, link it from the package directory.

chmod +x bin/zz.js
npm link
zz --help
zz create my-app --template dashboard

If you are using Termux, keep the project inside your Termux home directory instead of /sdcard to avoid executable permission problems.

mkdir -p ~/projects
cd ~/projects

After npm release: install globally

After ZhinNX is published to npm, install it globally with your package manager.

npm install -g zhinnx@beta

Then create a project.

zz create my-app
cd my-app
npm install --package-lock=false --no-audit --no-fund
npm run dev

Create a project

npx zhinnx@beta create my-app

Create with a template

npx zhinnx@beta create my-app --template dashboard

Available templates include blank, landing, dashboard, mobile-app, music-app, api-tool, and admin. Read the Templates guide for details.

Create with deploy config

npx zhinnx@beta create my-app --template dashboard --vercel --netlify

This generates deploy configuration for Vercel and Netlify. Read the Deployment guide before deploying production projects.

Package managers

The recommended path is npm or pnpm for daily development. Yarn works well for teams that already use it. Bun is useful when you want faster install times. Deno can run npm packages through its npm: compatibility layer, but treat the Deno CLI path as experimental until you test it in your own environment.

Next steps

Continue with the Getting Started guide, then read the CLI guide to understand every zz command.