Accelware Tool

accelware-tool is a command-line interface (CLI) tool that allows users to create and download project templates for Accelware quickly and easily.

Features

• Login Support: Authenticate with your credentials.
• Project Creation: Choose a project name and generate a custom template.
• API Integration: Fetch and download project templates directly from a remote API.

Installation

Prerequisites

• Node.js: Ensure you have Node.js installed on your machine. You can download it from nodejs.org.

Global Installation

Install the CLI tool globally using npm:

npm install -g codefusion/cli

Usage

Available Commands

accelware create

The primary command to create a new project.

When executed, the tool will:

1. Prompt for user login credentials.
2. Ask for a project name.
3. Automatically fetch the corresponding project template via API and download it.

Example:

accelware create

accelware --help

Displays a list of all available commands and usage instructions.

Example:

accelware --help

Examples

Creating a New Project

1. Run the create command:

   accelware create

2. Enter your credentials when prompted:

   Enter your username: john.doe
   Enter your password: *****

3. Specify the project name:

   Enter the project name: MyAwesomeProject

4. The tool will fetch the template, and you'll see a message like:

   Project template downloaded successfully!

5. Check your current directory for the downloaded project:

   ./MyAwesomeProject

Development

Run Locally

To test or develop the CLI locally:

1. Clone the repository:

   git clone https://github.com/your-username/accelware-tool.git

2. Navigate into the project directory:

   cd accelware-tool

3. Install dependencies:

   npm install

4. Run the CLI locally:

   node bin/cli.js create

Contributing

We welcome contributions to enhance the functionality of accelware-tool! To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -m "Add feature-name"

4. Push the branch:

   git push origin feature-name

5. Open a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.