CLI Commands
create-supaslidev
The scaffolding CLI for creating and managing Supaslidev workspaces.
create
Create a new Supaslidev workspace with a monorepo structure.
Usage:
npx create-supaslidev [create]
Options:
| Option | Description | Default |
|---|---|---|
-n, --name <name> | Name of the workspace | Interactive prompt |
-p, --presentation <name> | Name of the first presentation | my-first-deck |
-t, --template <template> | Template to use | default |
--git | Initialize a git repository | true |
--no-git | Skip git initialization | — |
--install | Run pnpm install after scaffolding | true |
--no-install | Skip pnpm install | — |
Examples:
# Interactive mode (prompts for all options)
npx create-supaslidev
# Non-interactive with all options
npx create-supaslidev create --name my-slides --presentation intro-deck
# Skip git and install steps
npx create-supaslidev create --name my-slides --no-git --no-install
status
Display workspace status including CLI version, pending migrations, and available presentations.
Usage:
npx create-supaslidev status
Output includes:
- CLI version and workspace state version
- Creation and last updated timestamps
- Number of pending migrations
- List of native and imported presentations
- Available CLI updates
Example:
npx create-supaslidev status
migrate
Run migrations to update the workspace structure and configurations.
Usage:
npx create-supaslidev migrate [options]
Options:
| Option | Description | Default |
|---|---|---|
--apply | Execute migrations (without this flag, runs in dry-run mode) | false |
Examples:
# Preview what migrations would be applied (dry-run)
npx create-supaslidev migrate
# Apply pending migrations
npx create-supaslidev migrate --apply
--apply first to preview changes before applying migrations.update
Check for CLI updates and display upgrade instructions.
Usage:
npx create-supaslidev update
Example:
npx create-supaslidev update
If an update is available, the command displays the current and latest versions along with installation instructions.
supaslidev (@supaslidev/dashboard)
The presentation management CLI for creating, developing, and exporting presentations.
dev
Start the Supaslidev dashboard UI and development server.
Usage:
pnpm supaslidev [dev]
Example:
# Start the dashboard
pnpm supaslidev
# Or explicitly
pnpm supaslidev dev
The dashboard provides a visual interface for managing all presentations in your workspace.
new
Create a new presentation in the workspace using the Slidev scaffolding wizard.
Usage:
pnpm supaslidev new [name]
Arguments:
| Argument | Description | Required |
|---|---|---|
name | Name for the new presentation | No (prompts if omitted) |
Examples:
# Interactive mode
pnpm supaslidev new
# With a specific name
pnpm supaslidev new quarterly-review
present
Start a development server for a specific presentation.
Usage:
pnpm supaslidev present <name>
Arguments:
| Argument | Description | Required |
|---|---|---|
name | Name of the presentation to start | Yes |
Example:
pnpm supaslidev present quarterly-review
This starts the Slidev development server with hot reload for the specified presentation.
export
Export a presentation to PDF format.
Usage:
pnpm supaslidev export <name> [options]
Arguments:
| Argument | Description | Required |
|---|---|---|
name | Name of the presentation to export | Yes |
Options:
| Option | Description | Default |
|---|---|---|
-o, --output <path> | Output path for the PDF file | dist/<name>.pdf |
Examples:
# Export to default location
pnpm supaslidev export quarterly-review
# Export to custom path
pnpm supaslidev export quarterly-review --output ./exports/q4-review.pdf
deploy
Build and prepare a presentation for deployment to hosting platforms.
Usage:
pnpm supaslidev deploy <name> [options]
Arguments:
| Argument | Description | Required |
|---|---|---|
name | Name of the presentation to deploy | Yes |
Options:
| Option | Description | Default |
|---|---|---|
-o, --output <path> | Output directory for deployment files | deploy/<name> |
Examples:
# Deploy to default location
pnpm supaslidev deploy quarterly-review
# Deploy to custom directory
pnpm supaslidev deploy quarterly-review --output ./deploy/q4
The deploy command:
- Builds the presentation using Slidev
- Creates a deployment package with the built files
- Adds configuration files for Vercel and Netlify
After running, follow the printed instructions to deploy to your preferred platform.
import
Import an existing Slidev presentation into the workspace.
Usage:
pnpm supaslidev import <source> [options]
Arguments:
| Argument | Description | Required |
|---|---|---|
source | Path to existing Slidev presentation directory | Yes |
Options:
| Option | Description | Default |
|---|---|---|
-n, --name <name> | Name for the imported presentation | Source directory name |
--no-install | Skip pnpm install after import | — |
Examples:
# Import with auto-detected name
pnpm supaslidev import /path/to/existing-presentation
# Import with custom name
pnpm supaslidev import /path/to/existing-presentation --name new-name
# Import without installing dependencies
pnpm supaslidev import /path/to/existing-presentation --no-install
slides.md and package.json files.Workspace Scripts
Supaslidev workspaces include convenience scripts in package.json:
| Script | Description |
|---|---|
pnpm dev | Start the dashboard (alias for supaslidev dev) |
pnpm new <name> | Create a new presentation |
pnpm present <name> | Start dev server for a presentation |
pnpm export <name> | Export presentation to PDF |
pnpm deploy <name> | Build for deployment |
pnpm dev:all | Start dev servers for all presentations |
pnpm build:all | Build all presentations |