CLI — Installation

The Shiva CLI is a Node.js tool that scaffolds modules, runs migrations, manages packages, generates documentation, and integrates with AI tools.

Install

npm install -g @shiva-fw/cli

Verify

shiva --version
# shiva-cli v1.0.0

Commands

Scaffolding

Command	Description
shiva init	Bootstrap a new Shiva server project
shiva make:module	Scaffold a new module
shiva make:service	Scaffold a service inside a module
shiva make:model	Scaffold a model
shiva make:migration	Scaffold a migration file
shiva make:seed	Scaffold a seed file
shiva make:contract	Scaffold a contract definition
shiva make:test	Scaffold a test spec file
shiva make:ui	Scaffold a NUI ui/ directory

Database

Command	Description
shiva migrate	Run pending migrations
shiva migrate:rollback	Roll back the last batch
shiva migrate:status	Show migration run status
shiva seed	Run seed files

Modules

Command	Description
shiva module:list	List all installed modules
shiva module:status	Show enabled/disabled status of each module

Packages

Command	Description
shiva install	Install packages from shiva.manifest
shiva update	Update all packages to latest compatible versions
shiva outdated	List packages with available updates
shiva remove <pkg>	Remove a package

Quality

Command	Description
shiva test	Run the test suite
shiva config:validate	Validate all module config files against their schema
shiva locale:missing	Report translation keys missing in any locale

AI & MCP

Command	Description
shiva ai:context	Generate a single-file AI context bundle for the whole server
shiva ai:link	Generate a shareable llms.txt-style link for Cursor/ChatGPT
shiva ai:mcp	Configure an AI tool to use the Shiva MCP server
shiva mcp start	Start the Shiva MCP server (used by Cursor/VS Code)

Documentation

Command	Description
shiva docs:api	Generate API reference from LuaLS annotations
shiva docs:build	Build the full documentation site
shiva docs:serve	Serve documentation locally
shiva docs:deploy	Deploy documentation to hosting

Global Options

--version   Print version and exit
--help      Show help for a command
--verbose   Enable verbose output
--cwd       Set working directory (default: current directory)