ward-cli

WARD-CLI

A CLI tool for Ward

Report Bug · Request Feature

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About

A CLI tool to create and serve Ward projects.

Getting Started

Prerequisites

• Node.js
• npm or Yarn (or any package manager)

Installation

# npm
npm install [-g] ward-cli

# Yarn
yarn [global] add ward-cli

Usage

new <name> [directory]

The new command will create a project in the directory called <name> (or create a new directory if it does not exist).

You can also specify a [directory] to specify where to create this project.

#Exemple:
ward new MyWardProject Projects # Creates a project called "MyWardProject" in the "Projects" directory.

serve [directory]

• -P, --port : Wish port to listen to. (Default: 8000)
• -I, --ip : Wish IP address to serve to. (Default: "127.0.0.1")

The serve command will serve the files of a specified [directory] (if not specified will serve the current working directory).

#Exemple:
ward serve --port 3000 # Serves the current working directory to the port 3000.

Contributing

This project is developed by a somewhat beginner javascript developer, help is always welcome. Do not hesitate to contribute to the project.

1. Fork the Project
2. Create your Feature or Fix Branch (git checkout -b feature/Feature or git checkout -b fix/Fix)
3. Commit your Changes (git commit -m 'Add some feature or fix')
4. Push to the Branch (git push origin feature/Feature or git push origin fix/Fix)
5. Open a Pull Request

License

ward-cli is distributed under the MIT License. See LICENSE for more information.

Contact

Colin Espinas - Website - [e-mail]

Project link: https://github.com/ColinEspinas/ward-cli

Acknowledgements

• commander.js
• simple-git
• ora
• chalk
• ward-server