Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaskaairlines/auro-cli
A cli tool to support the Auro Design System
https://github.com/alaskaairlines/auro-cli
auro cli design-system
Last synced: 15 days ago
JSON representation
A cli tool to support the Auro Design System
- Host: GitHub
- URL: https://github.com/alaskaairlines/auro-cli
- Owner: AlaskaAirlines
- License: apache-2.0
- Created: 2024-11-18T18:50:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-19T21:48:36.000Z (about 2 months ago)
- Last Synced: 2024-12-19T22:28:41.028Z (about 2 months ago)
- Topics: auro, cli, design-system
- Language: JavaScript
- Homepage: https://auro.alaskaair.com/auro-cli
- Size: 200 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Options](#options)
- [Examples](#examples)
## Installation
To install Auro CLI, clone the repository and install the dependencies:
```bash
npm install @aurodesignsystem/auro-cli
```
## Usage
To use Auro CLI, run the following command in your terminal:
```bash
auro dev
```
This will start the development server with default options.
## Commands
`auro dev`
Runs the web development server.
#### Options
- `-o, --open ` Open the server to a specific directory (default: demo/).
- `-p, --port ` 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/
```