Skip to main content

​
CLI Overview

The Scully CLI is the primary interface for building, serving, and managing your static Angular applications. It provides a comprehensive set of commands and options to control every aspect of the static site generation process.

​
Installation

Install Scully globally or as a dev dependency: 
npm install -D @scullyio/scully

​
Basic Usage

The general syntax for Scully CLI commands is: 
npx scully [command] [options]

​
Available Commands

​
Build Command (Default)

Builds and generates static files for your Angular application: 
npx scully
This is the default command that processes your Angular application and generates static HTML files.

​
serve

Starts the Scully development server: 
npx scully serve
Aliases: server, s

​
version

Displays the current Scully version: 
npx scully version

​
killServer

Kills any running Scully background server: 
npx scully killServer
Alias: ks

​
prepServe

Forces server setup from the project: 
npx scully prepServe

​
Command Line Options

Scully provides extensive command-line options to customize behavior. All options can be:
  • Passed as command-line flags
  • Set via environment variables using the SCULLY_ prefix
  • Configured in the scully.config.ts file
For detailed information about all available options, see the Options page.

​
Common Usage Patterns

​
Development Workflow

Build and serve with watch mode: 
npx scully --watch

​
Production Build

Generate static files for production: 
npx scully --prod

​
Selective Route Generation

Generate specific routes using filters: 
npx scully --routeFilter="/blog/*"

​
Debug Mode

Run with visible browser for debugging: 
npx scully --showBrowser

​
Environment Variables

From version 2.0.3 onwards, all CLI parameters can be provided via an environment variable called SCULLY (all caps): 
export SCULLY_watch=true
export SCULLY_showBrowser=true
npx scully

​
Exit Codes

Scully uses the following exit codes:
  • 0 - Success
  • 15 - Configuration error or fatal error during processing

​
Getting Help

Display help information: 
npx scully --help

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us