Feathers UI CLI command reference

Feathers UI provides an optional cli interface to create new projects in a terminal.

new-project

Creates a new Feathers UI project at the specified path

Usage

haxelib run feathersui new-project <path> [options]

Example: The following commands create a new project named HelloWorld and open the project folder in Visual Studio Code.

haxelib run feathersui new-project HelloWorld --vscode
code HelloWorld

Parameters

<path>

(Required) The path to a folder where the new project should be created. If the folder already exists, it must be empty. If it doesn't exist, it will be created.

Additional Options

The following options are available for the new-project command.

--vscode

The new project will include supporting files for Visual Studio Code

--openfl

The new project's main class will extend openfl.display.Sprite instead of feathers.controls.Application

--verbose

Show additional detailed output

help

Displays a list of available commands or the usage of a specific command

Usage

haxelib run feathersui help <command>

Example: Display a list of all available commands.

haxelib run feathersui help

Example: Display a list of all available options for the new-project command.

haxelib run feathersui help new-project

Parameters

<command>

(Optional) The name of the command