Skip to main content
The Deskofy CLI is a command-line tool for creating, running, building, and managing Deskofy projects. It provides a set of commands and options to simplify development workflows.

​
Global Options

​
Available Commands

​
create

Description: Initializes a new Deskofy project in the current directory. Usage:
Options: None Example:

​
run

Description: Runs a Deskofy project using the specified configuration file. Usage:
Positional Arguments: Example:

​
build

Description: Builds a Deskofy project for a specified target platform. Usage:
Options: Target Validation: The --target must match the current operating system: Example:
If an unsupported target is specified for the current platform, Deskofy will display an error and exit.

​
fmt

Description: Automatically formats all source code in the project. Usage:

​
lint

Description: Runs a linter to check code style and potential issues. Usage:

​
types

Description: Validates TypeScript types across the project. Usage:

​
Error Handling & Help

  • Strict Mode: Unknown commands or invalid arguments trigger errors.
  • Command Suggestions: If a typo is detected, the CLI suggests correct commands.
  • Default Behavior: Running deskofy without a command prints a default help message.