zudojs-cli
v1.0.0
Published
Command-line interface for scaffolding, generating, and managing Zudojs framework projects.
Maintainers
Readme
zudojs-cli
Command-line interface for scaffolding, generating, and managing Zudojs framework projects.
Installation
First time
npm install -g zudojs-cliUpgrading from an old version?
If zudojs -v doesn't match the latest npm version, clear the cache:
npm cache clean --force
npm install -g zudojs-cli@latestGetting permission errors?
Don't use sudo. Set up a user-local npm prefix instead:
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g zudojs-cli@latestQuick Start
# Create a new backend project
zudojs create my-api
# Create a frontend project
zudojs create my-web --type frontend --frontend react
# Create a fullstack project
zudojs create my-system --type fullstack --frontend next --architecture monolith
# Start development servers
zudojs dev
# Generate a module
zudojs generate module users
# Add a feature
zudojs add database
# Build the project
zudojs buildzudojs build and zudojs doctor exit with a non-zero status when they fail,
so they can be used as CI gates.
Disabling the update check
zudojs-cli checks npm for a newer version after a global install. Set
ZUDOJS_NO_UPDATE_CHECK=1 to turn it off; it is skipped automatically when
CI is set, when npm is offline, and for non-global installs.
Commands
| Command | Description |
| ---------- | ------------------------------------------------------------------------ |
| create | Scaffold a new project (backend, frontend, or fullstack) |
| generate | Generate files (service, module, command, query, controller, repository) |
| add | Add feature packages (database, queue, messaging, etc.) |
| dev | Start development servers |
| build | Build the project with its detected package manager |
| doctor | Run project diagnostics |
| info | Show project information |
Supported Frameworks
- Backend: Node.js (Zudojs runtime)
- Frontend: React, Next.js, Vue, Nuxt, Angular, Svelte, SvelteKit, Astro, Vanilla, Flutter, React Native
- Architectures: Monolith, Modular Monolith, Microservice
Documentation
See the Zudojs README for full documentation.
