CLI Commands

CLI Commands Reference

Complete reference for all DeskForge CLI commands with examples and options.

deskforge init

Initialize a new DeskForge project by creating a deskforge.config.json file.

Usage

deskforge init [options]

Options

-n, --name <name>

Project name

-u, --url <url>

Web app URL

-f, --force

Overwrite existing config

Example

deskforge init --name "My App" --url "https://myapp.com"

deskforge login

Authenticate the CLI with your DeskForge account.

Usage

deskforge login

Authentication Flow

  1. Prompts for email address
  2. Prompts for access token (get from dashboard Settings → Access Tokens)
  3. Validates credentials with DeskForge API
  4. Stores credentials securely in system keychain

deskforge logout

Remove stored authentication credentials.

deskforge logout

deskforge account

Display current account information.

Output

  • Email address
  • Account plan (Free, Pro, Team)
  • Monthly build usage
  • Build limit

deskforge build

Build your desktop application (remote or local).

Options

-p, --platform <platform>

Target platform: mac, windows, linux

-a, --arch <arch>

Target architecture: x64, arm64

--local

Build locally instead of using cloud infrastructure

--watch

Watch for changes and rebuild automatically

Examples

# Remote build for macOS
deskforge build --platform mac

# Local build for development
deskforge build --local

# Build for Windows x64
deskforge build --platform windows --arch x64

# Watch mode for local development
deskforge build --local --watch

deskforge dev

Start a local Tauri development environment with hot reload.

Options

-p, --port <port>

Dev server port (default: 3000)

--open

Open DevTools automatically

Example

# Start dev server on default port
deskforge dev

# Use custom port and open DevTools
deskforge dev --port 8080 --open

deskforge projects

Manage your DeskForge projects.

List Projects

deskforge projects list
deskforge projects list --json

Show Project

deskforge projects show my-app

Delete Project

deskforge projects delete my-app
deskforge projects delete my-app --yes

deskforge logs

View build logs for a specific build.

Options

-f, --follow

Follow log output in real-time

-n, --lines <number>

Number of lines to show (default: 100)

Example

# View last 100 lines
deskforge logs build_abc123

# Follow logs in real-time
deskforge logs build_abc123 --follow

# Show last 500 lines
deskforge logs build_abc123 --lines 500

deskforge config

Manage your DeskForge configuration.

Show Configuration

deskforge config show

Set Value

deskforge config set window.width 1400
deskforge config set features.autoUpdate true

Get Value

deskforge config get window.width
deskforge config get platforms

Validate Configuration

deskforge config validate