CLI Commands

Complete reference for all AutoDeployBase CLI commands.

Global Options

autodeploybase [command] [options]

Options:
  -v, --version    Show version number
  -h, --help       Show help information
  --verbose        Enable verbose output
  --quiet          Suppress non-essential output

init

Create a new project with interactive prompts or options.

autodeploybase init <project-name> [options]

Arguments

Argument	Description
project-name	Name of the project (kebab-case recommended)

Options

Option	Description	Default
-f, --framework <name>	Framework to use	(prompt)
-d, --database <name>	Database to use	(prompt)
-a, --archetype <name>	Project archetype	(prompt)
--plugins <list>	Comma-separated plugin names	(prompt)
--skip-install	Skip npm install	false
--skip-git	Skip git initialization	false
--dry-run	Show what would be created	false
-y, --yes	Accept all defaults	false

Examples

# Interactive mode
autodeploybase init my-app

# With options
autodeploybase init my-app -f next -d postgresql

# Using archetype
autodeploybase init my-saas --archetype saas

# With plugins
autodeploybase init my-app --plugins auth-jwt,payments-stripe

# Dry run (preview only)
autodeploybase init my-app --dry-run

generate

Generate or regenerate project files based on configuration.

autodeploybase generate [options]

Options

Option	Description	Default
-c, --config <path>	Path to config file	autodeploy.config.json
--only <type>	Generate only specific type	all
--force	Overwrite existing files	false
--dry-run	Preview changes without writing	false
--no-overwrite	Skip files that exist	false

Types for --only

• framework - Framework files only
• database - Database schema and migrations
• entities - Entity pages and components
• plugins - Plugin files only

Examples

# Generate all
autodeploybase generate

# Generate framework files only
autodeploybase generate --only framework

# Preview changes
autodeploybase generate --dry-run

# Custom config file
autodeploybase generate -c ./config/custom.json

# Don't overwrite existing files
autodeploybase generate --no-overwrite

add

Add a plugin to an existing project.

autodeploybase add <plugin-name> [options]

Arguments

Argument	Description
plugin-name	Name of the plugin to add

Options

Option	Description	Default
--skip-install	Skip npm install	false

Examples

# Add authentication
autodeploybase add auth-jwt

# Add payments
autodeploybase add payments-stripe

# Add multiple plugins
autodeploybase add email file-storage

# Add without installing deps
autodeploybase add email --skip-install

remove

Remove a plugin from the project.

autodeploybase remove <plugin-name> [options]

Options

Option	Description	Default
--keep-files	Don't delete generated files	false

Example

autodeploybase remove email
autodeploybase remove payments-stripe --keep-files

list

List available plugins, frameworks, and databases.

autodeploybase list [options]

Options

Option	Description	Default
-t, --type <type>	Filter by type	all
--tier <tier>	Filter by tier (public/premium)	all
--json	Output as JSON	false

Types

• framework - Web frameworks
• database - Databases
• feature - Feature plugins
• deployment - CI/CD and deployment

Examples

# List all plugins
autodeploybase list

# List frameworks only
autodeploybase list -t framework

# List premium features
autodeploybase list --tier premium

# JSON output
autodeploybase list --json

plugins

Manage plugin cache and status.

autodeploybase plugins <subcommand>

Subcommands

# Show cached plugins
autodeploybase plugins list

# Show cache information
autodeploybase plugins cache

# Show status for specific plugin
autodeploybase plugins status payments-stripe

# Clear the plugin cache
autodeploybase plugins clear

wizard

Open the web-based configuration wizard.

autodeploybase wizard [options]

Options

Option	Description	Default
-p, --port <number>	Server port	3456
--no-open	Don't open browser	false

Example

# Start wizard on default port
autodeploybase wizard

# Use custom port
autodeploybase wizard -p 8080

doctor

Check system requirements and diagnose issues.

autodeploybase doctor [options]

Options

Option	Description	Default
--fix	Attempt to fix issues	false

Checks

• Node.js version
• npm/yarn/pnpm availability
• Git installation
• Database tools
• Required global packages

Example Output

AutoDeployBase Doctor

Checking system requirements...

✓ Node.js v20.10.0 (required: ≥18.0.0)
✓ npm v10.2.3
✓ Git v2.42.0
✓ PostgreSQL client v16.0
⚠ MongoDB client not found (optional)

All required checks passed!

upgrade

Upgrade plugins to latest versions.

autodeploybase upgrade [plugin-name] [options]

Options

Option	Description	Default
--dry-run	Preview changes	false

Examples

# Upgrade all plugins
autodeploybase upgrade

# Upgrade specific plugin
autodeploybase upgrade auth-jwt

# Preview changes
autodeploybase upgrade --dry-run

Exit Codes

Code	Meaning
0	Success
1	General error
2	Invalid arguments
3	Configuration error
4	Plugin error
5	Generation error

Environment Variables

Variable	Description
AUTODEPLOYBASE_CONFIG	Default config file path
AUTODEPLOYBASE_CACHE_DIR	Plugin cache directory
AUTODEPLOYBASE_NO_COLOR	Disable colored output
AUTODEPLOYBASE_VERBOSE	Enable verbose logging