Skip to main content
The Deskofy Command Line Interface (CLI) is the primary tool for performing all operations related to Deskofy applications, including project creation, running, and building. To get started, you only need to install the CLI, which then handles most development workflows automatically.

​
Required Tools

To use the Deskofy CLI, Node.js must be installed on your system. The minimum supported version is 22.18.0. If your Node.js version is lower, you need to upgrade to at least this version to ensure the CLI and related packages run smoothly.

​
Installing the CLI

The Deskofy CLI can be installed via npm either locally or globally. It is recommended to install globally as it simplifies project setup and usage. Local installation requires manual management and is generally unnecessary. To install globally, run the following command in your terminal: 
npm install -g @deskofy/cli

​
Verifying Installation

After installation, verify that the CLI is working by running: 
deskofy
If the CLI is installed correctly, you should see output similar to: 
Usage: deskofy [command]

Try 'deskofy -h' for a list of available commands.

Examples:
  $ deskofy create : Create a deskofy app
  $ deskofy run    : Run deskofy app
This confirms that the CLI is ready for use.