renweb-cli

The official CLI tool for RenWeb Engine — scaffold, develop, build, and package cross-platform desktop applications from the command line.

Installation

npm install -g renweb-cli

Commands

| Command | Description | |---------|-------------| | rw create [type] | Scaffold a new RenWeb project (app or plugin) | | rw init [dir] | Integrate RenWeb into an existing project | | rw run | Launch the engine for the current project | | rw build | Build the project (copy manifests, fetch engine and plugins, run bundler) | | rw update | Update the engine for the current project | | rw doctor | Check environment and project health | | rw package | Package build output into distributable archives (.deb, .rpm, .zip, .tar.gz) | | rw doc [pages...] | Open RenWeb documentation pages in a browser | | rw fetch [verb] | Download engine assets (executable, plugin binary, JS/TS API files, or example archive) | | rw docker <action> | Manage the renweb-cli Docker image (build, rebuild, kill, delete) |

Project Types (rw create)

Applications: Angular, Vite, Deno, vanilla, and Angular variants.

Other: plugin — scaffold a new C++ plugin, engine — clone the full engine repository.

Features

• Zero-config project scaffolding for popular frontend frameworks
• Automatic engine and plugin fetching from GitHub releases
• Cross-platform packaging: .deb, .rpm, .tar.gz, .zip
• Architecture and OS filters for targeted packaging
• Docker support for isolated build environments
• Inline documentation viewer (rw doc)

Usage Examples

# Create a new vanilla RenWeb app
rw create vanilla

# Create an Angular app and skip prompts
rw create angular --yes

# Build and package for Linux x86_64 as .deb
rw build
rw package -olinux -ax86_64 -edeb

# Fetch the latest engine executable
rw fetch executable

# Fetch the latest example archive (zip on Windows, tar.gz on macOS/Linux)
rw fetch example

# Check environment health
rw doctor

License

Copyright (C) 2025 spur27 — Boost Software License 1.0