The Rspack-based build tool providing high-performance bundling with comprehensive development features and plugin system.
—
Command-line interface functionality for build scripts and development workflows. Provides programmatic access to Rsbuild's CLI commands and configuration.
Execute the Rsbuild CLI programmatically with command-line arguments.
/**
* Execute Rsbuild CLI with current process arguments
* @returns Promise that resolves when CLI execution completes
*/
function runCLI(): Promise<void>;Usage Examples:
import { runCLI } from "@rsbuild/core";
// Run CLI with current process arguments
// Equivalent to running: rsbuild build, rsbuild dev, etc.
await runCLI();Available commands when using the Rsbuild CLI:
rsbuild dev - Start development serverrsbuild build - Build for productionrsbuild preview - Preview production buildrsbuild inspect - Inspect resolved configurationCommon command-line options:
# Development server
rsbuild dev [options]
--port <port> # Server port (default: 3000)
--host <host> # Server host (default: localhost)
--open # Open browser automatically
--config <path> # Config file path
# Production build
rsbuild build [options]
--config <path> # Config file path
--mode <mode> # Build mode (development/production)
--analyze # Bundle analyzer
--env <env> # Environment variables file
# Preview build
rsbuild preview [options]
--port <port> # Preview server port
--host <host> # Preview server host
--open # Open browser automatically
# Inspect configuration
rsbuild inspect [options]
--env <env> # Environment to inspect
--output <path> # Output file path
--verbose # Verbose output// In a Node.js script
import { runCLI } from "@rsbuild/core";
// Set command line arguments programmatically
process.argv = [
"node",
"script.js",
"build",
"--mode", "production",
"--config", "./rsbuild.prod.config.ts"
];
await runCLI();The @rsbuild/core package includes a binary executable located at ./bin/rsbuild.js:
{
"bin": {
"rsbuild": "./bin/rsbuild.js"
}
}This allows direct execution when installed:
# Global installation
npm install -g @rsbuild/core
rsbuild dev
# Local installation
npx rsbuild dev
# Package.json scripts
{
"scripts": {
"dev": "rsbuild dev",
"build": "rsbuild build",
"preview": "rsbuild preview"
}
}CLI automatically detects and sets appropriate environment variables:
// CLI sets NODE_ENV based on command
// rsbuild dev -> NODE_ENV=development
// rsbuild build -> NODE_ENV=production
// rsbuild preview -> NODE_ENV=productionCLI automatically searches for configuration files in order:
rsbuild.config.tsrsbuild.config.jsrsbuild.config.mjsrsbuild.config.mtsrsbuild.config.ctsrsbuild.config.cjsCustom config path:
rsbuild build --config custom.config.tsInstall with Tessl CLI
npx tessl i tessl/npm-rsbuild--core