Skip to content

AlaskaAirlines/auro-cli

Repository files navigation

Auro CLI

Auro CLI is a command-line interface designed to help consumers of the Auro Design System and the developers maintaining it.

Dev Command Features

  • Start Development Server: Quickly launch a web development server with default or custom configurations.
  • Customizable Options: Specify the port and the directory to open when the server starts.
  • Hot Module Replacement: Integrates with HMR (Hot Module Replacement) for a better development experience.
  • Graceful Error Handling: Handles invalid inputs and missing options gracefully.

Table of Contents

Installation

To install Auro CLI, clone the repository and install the dependencies:

npm install @aurodesignsystem/auro-cli

Usage

To use Auro CLI, run the following command in your terminal:

auro dev

This will start the development server with default options.

Commands

auro dev Runs the web development server.

Options

  • -o, --open <type> Open the server to a specific directory (default: demo/).
  • -p, --port <type> Change the server port (default: undefined).

Examples

Start the server on a specific port:

auro dev --port 8000

Open the server to a specific directory:

auro dev --open src/