CLI Commands¶

crabyard new¶

Generate a new Tauri v2 desktop app.

crabyard new [APP_NAME] [OPTIONS]

Arguments¶

Options¶

Environment variables¶

Examples¶

# Fully interactive
crabyard new

# Named, interactive module selection
crabyard new "My App"

# Fully non-interactive
crabyard new "My App" --auth github --ui shadcn --yes

# Using a local template
crabyard new "My App" --template ./my-scaffold --yes --no-install

Presets and reproducible recipes¶

crabyard presets
crabyard presets --json
crabyard new "My App" --preset desktop --yes
crabyard new "Local Notes" --preset local-first --dry-run
crabyard new --recipe ./my-app/crabyard.recipe.toml --output ./another-app --yes

minimal selects no authentication and the minimal UI. desktop adds shadcn, logging, saved window state, and notifications. local-first selects shadcn, SQLite, logging, saved window state, and a command palette.

Every generated app includes crabyard.recipe.toml with its selected stack and app metadata. Commit the recipe to reproduce that selection. Explicit flags override recipe fields. Recipes reject unknown fields and exclude license keys and machine paths.

For source generation in CI, use a local checkout of crabyard-templates:

crabyard new "CI App" --template ../crabyard-templates --preset minimal --yes --no-install --no-git

This path does not prompt or install desktop toolchains. Building the generated app still requires the platform prerequisites.

crabyard doctor¶

Check system prerequisites for Tauri development.

crabyard doctor

Verifies the following are installed and meet minimum versions:

Outputs a pass/fail summary with version numbers and actionable fix instructions for any failures.

crabyard check¶

Inspect a generated project's configuration without changing files.

crabyard check --project ./my-app
crabyard check --project ./my-app --json
crabyard check --project ./my-app --strict

The report checks project identity, missing lockfiles and agent guidance, OAuth configuration, release preparation, capabilities, and secret-ignore hazards. Findings include stable IDs and next actions. Errors return exit code 1; --strict also treats warnings as failures. --project defaults to the current directory.

crabyard context¶

Export a focused coding-agent handoff for the current project.

crabyard context --project ./my-app --brief "Add tags and Markdown export"
crabyard context --project ./my-app --brief "Add search" --dry-run
crabyard context --project ./my-app --brief "Add search" --output docs/SEARCH_CONTEXT.md

The default output is docs/AI_CONTEXT.md. The document includes selected stack and features, relevant files, readiness blockers, and a first-slice and verification plan. Environment values and source bodies are excluded. Existing output files are preserved. See AI Handoff & Readiness.

crabyard update-ui¶

Update or switch the UI framework in an existing project.

crabyard update-ui [OPTIONS]

Options¶

Examples¶

# Switch from shadcn to daisyui
crabyard update-ui --switch daisyui

# Preview changes without applying
crabyard update-ui --switch minimal --dry-run

# Rollback to the previous UI
crabyard update-ui --rollback

crabyard add¶

Add a Tauri plugin or feature to an existing project. Automatically wires up npm dependencies, Cargo dependencies, Tauri plugin registration, and capabilities.

crabyard add <FEATURE> [OPTIONS]

Arguments¶

Options¶

Available features¶

Examples¶

# List available features
crabyard add list

# Add notifications plugin
crabyard add notifications

# Preview adding SQL support
crabyard add sql --dry-run

crabyard eject¶

Remove Crabyard metadata from a generated project, leaving a clean standalone Tauri app. Deletes manifest.toml and strips any remaining CRABYARD: markers from source files.

crabyard eject [OPTIONS]

Options¶

Examples¶

# Eject the current project
crabyard eject

# Preview what would be removed
crabyard eject --dry-run

crabyard preview¶

Preview the file tree that would be generated for a given auth and UI combination, without creating any files.

crabyard preview [OPTIONS]

Options¶

Examples¶

# Preview default scaffolding (none auth + shadcn)
crabyard preview

# Preview with GitHub auth and DaisyUI
crabyard preview --auth github --ui daisyui

crabyard upgrade¶

Check for and apply template updates to an existing project. Compares your project files against the latest template version and shows what has changed.

crabyard upgrade [OPTIONS]

Options¶

Examples¶

# Check for template updates
crabyard upgrade --dry-run

# Apply template updates
crabyard upgrade --force

crabyard plugins¶

Browse the catalog of official Tauri v2 plugins with descriptions and install hints.

crabyard plugins [FILTER]

Arguments¶

Examples¶

# List all plugins
crabyard plugins

# Filter by keyword
crabyard plugins window

crabyard init¶

Initialize Crabyard in an existing Tauri v2 project. Detects the current project name and bundle identifier from tauri.conf.json and writes a manifest.toml so that crabyard update-ui, crabyard add, and crabyard upgrade can be used.

crabyard init [OPTIONS]

Options¶

Examples¶

# Initialize in current directory
crabyard init

# Initialize a specific project
crabyard init -p ../my-tauri-app

crabyard completions¶

Generate shell completion scripts for crabyard commands.

crabyard completions <SHELL>

Arguments¶

Examples¶

# Bash
crabyard completions bash >> ~/.bashrc

# Zsh
crabyard completions zsh >> ~/.zshrc

# Fish
crabyard completions fish > ~/.config/fish/completions/crabyard.fish

# PowerShell
crabyard completions powershell >> $PROFILE

Configuration file¶

Crabyard reads ~/.crabyardrc (TOML format) for default preferences. CLI flags and environment variables always take priority over config file values.

[defaults]
pm = "bun"
auth = "github"
ui = "shadcn"
author = "Your Name"
license_key = "CRAB-..."