Viseed CMS

Appearance

CLI Reference ​

The viseed CLI is the companion tool for Viseed CMS projects. It handles project scaffolding, database management, and plugin/theme management.

Installation ​

The CLI is available as @viseed/cli. You can use it without installing via bunx:

bash
bunx @viseed/cli <command>

Or install it as a dev dependency in your project:

bash
bun add -d @viseed/cli

viseed init ​

Scaffold a new Viseed CMS project.

bash
viseed init <project-name>

Example:

bash
bunx @viseed/cli init my-blog
cd my-blog
bun install

Creates the following structure:

my-blog/
├── src/
│   └── index.ts     # Entry point with createCMS, authPlugin, blogPlugin
├── package.json
└── tsconfig.json

The generated src/index.ts is pre-configured with authPlugin and blogPlugin, using HANA_ADMIN_EMAIL / HANA_ADMIN_PASSWORD env vars for the initial admin account.

viseed db ​

Manage your database schema using Drizzle.

All db subcommands require DATABASE_URL to be set:

bash
export DATABASE_URL="postgresql://user:password@localhost:5432/hana"

viseed db push ​

Push the current schema directly to the database. Intended for development only.

bash
bunx viseed db push
  • Fast — no migration files generated
  • May drop or alter columns to match the schema
  • Not safe for production databases with live data

viseed db generate ​

Generate SQL migration files from the current schema. Intended for production.

bash
bunx viseed db generate
  • Creates timestamped .sql files in drizzle/
  • Safe to review and commit to source control
  • Does not apply changes to the database

viseed db migrate ​

Apply pending migration files to the database.

bash
bunx viseed db migrate
  • Reads migration files from drizzle/
  • Safe for production — applies only new migrations
  • Requires migration files to exist (run db generate first)

How it works ​

The CLI scans your package.json for viseed-plugin-* dependencies and auto-generates a schema barrel file at .viseed/_schema.ts. This file is used by drizzle-kit to run the requested operation. The .viseed/ directory is automatically added to .gitignore.

viseed plugin ​

Manage plugins in your project.

viseed plugin install ​

bash
viseed plugin install <package-name>

Installs the package via bun add and prints a reminder to restart the server.

Example:

bash
bunx viseed plugin install viseed-plugin-pages

After installing, register the plugin in your src/index.ts:

typescript
import { pagesPlugin } from 'viseed-plugin-pages'
cms.use(pagesPlugin())

Then push the updated schema:

bash
bunx viseed db push   # development
# or
bunx viseed db generate && bunx viseed db migrate   # production

viseed plugin uninstall ​

bash
viseed plugin uninstall <package-name>

Removes the package via bun remove.

viseed theme ​

Manage themes in your project.

viseed theme install ​

bash
viseed theme install <package-name>

Example:

bash
bunx viseed theme install viseed-theme-blog

After installing, register the theme in your config:

typescript
import { blogTheme } from 'viseed-theme-blog'

const cms = createCMS({
  themes: [blogTheme()],
  defaultTheme: 'blog',
  // ...
})

viseed theme uninstall ​

bash
viseed theme uninstall <package-name>

Command Summary ​

CommandDescription
viseed init <name>Scaffold a new project
viseed db pushPush schema to DB (dev)
viseed db generateGenerate SQL migration files (prod)
viseed db migrateApply pending migrations (prod)
viseed plugin install <package>Install a plugin
viseed plugin uninstall <package>Uninstall a plugin
viseed theme install <package>Install a theme
viseed theme uninstall <package>Uninstall a theme