> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nativedesktop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Introduction

> Introduction to the Native Desktop Command Line Interface

The Native Desktop CLI is a powerful command-line tool that enables you to create, develop, build, and distribute native desktop applications with ease. Built on modern web technologies, it provides a streamlined workflow for desktop application development.

## Installation

The Native Desktop CLI is available as a private package on GitHub. Access is granted upon purchase of a Native Desktop license.

Once you have access, install the CLI globally using npm:

```shellscript theme={null}
npm install -g @native-desktop/cli
```

Or install a specific version:

```shellscript theme={null}
npm install -g @native-desktop/cli@1.0.0
```

<Note>
  You must be authenticated with GitHub and have access to the private repository to install the package. Contact support if you've purchased a license but don't have access.
</Note>

## Getting Started

Once installed, you can access the CLI using the `native-desktop` command in your terminal. To see all available commands and options, run:

```shellscript theme={null}
native-desktop --help
```

## Core Features

The Native Desktop CLI provides several key features to streamline your development workflow:

* **Project Initialization**: Quickly scaffold new Native Desktop projects with customizable templates
* **Development Server**: Run your application in development mode with hot-reload support
* **Build System**: Compile and package your application for distribution across multiple platforms
* **Code Quality Tools**: Built-in linting, formatting, and type-checking capabilities
* **Code Signing**: Sign your applications for Windows and macOS distribution

## Available Commands

The Native Desktop CLI includes the following commands:

* `create` - Initialize a new Native Desktop project
* `run` - Run your application in development mode
* `build` - Build your application for production
* `sign` - Sign your built application
* `lint` - Run ESLint on your project
* `fmt` - Format your code with Prettier
* `types` - Check TypeScript types in your project

## Platform Support

Native Desktop CLI supports development on the following operating systems:

* **macOS** (darwin)
* **Windows** (win32)
* **Linux**

<Note>
  You can only build applications for the operating system you are currently using. Cross-platform builds are not currently supported.
</Note>

## Version Information

To check your installed CLI version, use:

```shellscript theme={null}
native-desktop --version
```

Or use the short alias:

```shellscript theme={null}
native-desktop -v
```

## Getting Help

For any command, you can view detailed help information by appending `--help`:

```shellscript theme={null}
native-desktop <command> --help
```

For example:

```shellscript theme={null}
native-desktop build --help
```