CLI Reference

Complete reference for all StarryKit CLI commands.

Global Commands

starry-slides create <name>

Create a new presentation project.

starry-slides create my-presentation
# Options:
#   --template <name>  Use a specific template
#   --dir <path>       Create in a specific directory

starry-slides serve

Start the local development server.

starry-slides serve
# Options:
#   --port <number>    Port to listen on (default: 3000)
#   --open             Open browser automatically

starry-slides build

Build the presentation for production.

starry-slides build
# Options:
#   --outDir <path>    Output directory (default: dist/)

starry-slides export

Export presentation to various formats.

starry-slides export --format pdf
starry-slides export --format png
# Options:
#   --format <type>    Export format: pdf, png, html
#   --output <path>    Output file path

Configuration

starry.config.js

Main configuration file at the project root:

module.exports = {
  theme: "starry-night",
  title: "My Presentation",
  author: "Your Name",
  plugins: [],
};