CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-rsbuild--core

The Rspack-based build tool providing high-performance bundling with comprehensive development features and plugin system.

Pending
Overview
Eval results
Files

cli-integration.mddocs/

CLI Integration

Command-line interface functionality for build scripts and development workflows. Provides programmatic access to Rsbuild's CLI commands and configuration.

Capabilities

Run CLI

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();

CLI Commands

Available commands when using the Rsbuild CLI:

  • rsbuild dev - Start development server
  • rsbuild build - Build for production
  • rsbuild preview - Preview production build
  • rsbuild inspect - Inspect resolved configuration

CLI Options

Common 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

Programmatic CLI Usage

// 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();

Binary Integration

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"
  }
}

Environment Integration

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=production

Configuration File Resolution

CLI automatically searches for configuration files in order:

  1. rsbuild.config.ts
  2. rsbuild.config.js
  3. rsbuild.config.mjs
  4. rsbuild.config.mts
  5. rsbuild.config.cts
  6. rsbuild.config.cjs

Custom config path:

rsbuild build --config custom.config.ts

Install with Tessl CLI

npx tessl i tessl/npm-rsbuild--core

docs

cli-integration.md

configuration-management.md

core-build-system.md

development-server.md

environment-system.md

environment-variables.md

index.md

plugin-system.md

tile.json