CLI Commands

The Lito CLI provides powerful commands to develop, build, and manage your documentation site. All commands support detailed options for customization.

Note

If you have Lito installed globally, use lito <command>. Otherwise, use npx @litodocs/cli <command>.

`build`

Builds your documentation site for production deployment.

# With global installation
lito build --input ./my-docs --output ./dist [options]

# With npx
npx @litodocs/cli build --input ./my-docs --output ./dist [options]

Options

Option	Alias	Type	Description	Default
`--input`	`-i`	`<path>`	Required. Path to your docs folder	—
`--output`	`-o`	`<path>`	Output directory for the built site	`./dist`
`--template`	`-t`	`<name>`	Template to use: `default`, `github:owner/repo`, or local path	`default`
`--base-url`	`-b`	`<url>`	Base URL for the site (useful for subpath deployments)	`/`
`--provider`	—	`<name>`	Hosting optimization: `vercel`, `netlify`, `cloudflare`, `static`	`static`
`--rendering`	—	`<mode>`	Rendering mode: `static`, `server`, `hybrid`	`static`
`--name`	—	`<name>`	Set project name	—
`--description`	—	`<text>`	Set project description	—
`--primary-color`	—	`<hex>`	Set primary theme color (hex format)	—
`--accent-color`	—	`<hex>`	Set accent theme color (hex format)	—
`--favicon`	—	`<path>`	Set favicon path	—
`--logo`	—	`<path>`	Set logo path	—
`--search`	—	flag	Enable search functionality	`false`
`--refresh`	—	flag	Force re-download template from GitHub, bypassing cache	`false`

Example

lito build -i ./docs -o ./build \
  --provider cloudflare \
  --rendering server \
  --name "My Documentation" \
  --description "Complete reference" \
  --primary-color "#0066CC" \
  --search

`dev`

Starts a local development server with hot module reloading. Perfect for editing and previewing changes in real-time.

# With global installation
lito dev --input ./my-docs [options]

# With npx
npx @litodocs/cli dev --input ./my-docs [options]

Options

Option	Alias	Type	Description	Default
`--input`	`-i`	`<path>`	Required. Path to your docs folder	—
`--template`	`-t`	`<name>`	Template to use: `default`, `github:owner/repo`, or local path	`default`
`--base-url`	`-b`	`<url>`	Base URL for the site	`/`
`--port`	`-p`	`<number>`	Port for the development server	`4321`
`--name`	—	`<name>`	Set project name	—
`--description`	—	`<text>`	Set project description	—
`--primary-color`	—	`<hex>`	Set primary theme color (hex format)	—
`--accent-color`	—	`<hex>`	Set accent theme color (hex format)	—
`--favicon`	—	`<path>`	Set favicon path	—
`--logo`	—	`<path>`	Set logo path	—
`--search`	—	flag	Enable search functionality	`false`
`--refresh`	—	flag	Force re-download template from GitHub, bypassing cache	`false`

Example

lito dev -i ./docs -p 5000 \
  --name "Development Docs" \
  --primary-color "#3B82F6"

`eject`

Exports the complete Astro project source code. Use this when you need full control over the project and want to customize beyond what Lito configuration allows.

# With global installation
lito eject --input ./my-docs --output ./astro-docs-project [options]

# With npx
npx @litodocs/cli eject --input ./my-docs --output ./astro-docs-project [options]

Options

Option	Alias	Type	Description	Default
`--input`	`-i`	`<path>`	Required. Path to your docs folder	—
`--output`	`-o`	`<path>`	Output directory for the Astro project	`./astro-docs-project`
`--template`	`-t`	`<name>`	Template to use: `default`, `github:owner/repo`, or local path	`default`
`--base-url`	`-b`	`<url>`	Base URL for the site	`/`
`--name`	—	`<name>`	Set project name	—
`--description`	—	`<text>`	Set project description	—
`--primary-color`	—	`<hex>`	Set primary theme color (hex format)	—
`--accent-color`	—	`<hex>`	Set accent theme color (hex format)	—
`--favicon`	—	`<path>`	Set favicon path	—
`--logo`	—	`<path>`	Set logo path	—
`--search`	—	flag	Enable search functionality	`false`
`--refresh`	—	flag	Force re-download template from GitHub, bypassing cache	`false`

Example

lito eject -i ./docs -o ./my-astro-project \
  --name "Customizable Docs" \
  --primary-color "#10B981" \
  --refresh

Once ejected, you have a full Astro project and can use all standard Astro commands:

cd my-astro-project
npm install
npm run dev
npm run build

`template list`

Lists all available Lito templates.

lito template list
# or
npx @litodocs/cli template list

`template cache`

Manages the template cache.

lito template cache [options]
# or
npx @litodocs/cli template cache [options]

Options

Option	Description
`--clear`	Clear all cached templates to free up disk space

Example

lito template cache --clear

`upgrade`

Checks for updates and upgrades Lito to the latest version.

lito upgrade
# or
npx @litodocs/cli upgrade

This command will:

Check the npm registry for the latest version
Compare it with your installed version
Prompt you to confirm the upgrade
Automatically detect your package manager (pnpm, yarn, or npm)
Run the appropriate install command

Example Output

🔍 Checking for updates...

  Current version: 0.5.1
  Latest version:  0.5.2

? Upgrade from 0.5.1 to 0.5.2? (Y/n)

Tip

Lito automatically checks for updates when you run any command. If an update is available, you’ll see a notification suggesting to run lito upgrade.