ALPHA CLI

alpha CLI is a command-line interface for managing, developing and publishing the packages.

Installation

To install alpha CLI, use the following command:

npm i -g @jatahworx/alpha-cli

Usage

    alpha command [options]

Commands

• new <name> Create a new project
• generate | g Generate a new plugin. Run "help generate" for more information.
• auth Perform authentication tasks like login, logout, or status
• publish [options] [packageName] Bundle and publish the plugin
• build <type> [pluginName] Build the plugin
• start [options] Start the live server for the plugin
• serve Start the express server that serves the plugins

Options

• -v, --version Output the version number
• -h, --help Display help for command

Commands

new <name>

Description

• Create a new project with the given name. The project will be created in the current directory.

Usage

    alpha new <name>

Arguments

• <name> project or workspace name

generate | g

Description

• Generate a new component or module

Usage

    alpha generate [command] [argument] || alpha g [command] [argument]

commands

• component <name> | c <name> Component is a package enabling drag and drop functionality within the canvas
• module <name> | m <name> Module is a globally accessible package, available throughout the entire project on alpha.plugins | ap.
• attribute [command] [options] | a [command] [options] Generate an Attribute for a component, Read the ATTRIBUTE.md file in projetc/workspcae directory for more help

Arguments

• <name> component or module name

Build <type> [pluginName]

Description

• Build the plugins

Usage

    alpha build <type> [pluginName]

Arguments

• <type> The type of build, it can be one of plugin or docker
• pluginName package Name of the component/module to build, it is an optional argument and if not pluginName it will build every package in the current workspace

start [options]

Description

• Start the live server for the workspace

Usage

    alpha start [options]

Options

• -p, --port <port> Port to start the server on, default is 6969

serve

Description

• Start the express server that serves the plugins

Usage

    alpha serve

auth [command]

Description

• Perform authentication tasks like login or status

Usage

    alpha auth [command]

Commands:

• login Authenticate with the server
• state Get the current state of auth

publish [PackageName] [options]

Description

• Publish a package to the server

Usage

    alpha publish [PackageName] [Options]

Arguments

• PackageName The name of the component/module to publish, if not cli will show the list of packages inside the current workspace/project

Options

• -t, --version-type <versionType> Version type for verion up, it can be one of patch, minor, major
• -d, --display-name <displayName> Display Name for the package
• -i, --icon <iconPath> Path to the icon
• -m, --images <imagePaths...> path to the image