Gearup CLI Documentation

Overview

The gearup CLI is a tool designed to simplify and speed up the setup process for development environments. It automates the installation of essential tools, saving time and reducing manual effort.

Current Features

• Install Docker
• Install Docker Compose
• Cloudflared Tunnel

Planned Features

• Install curl
• Install git
• Install nvm
• Install zsh
• Additional tools (to be determined)

Installation

Prerequisites

• A Unix-based operating system (Linux, macOS)
• Basic knowledge of terminal usage

Install the CLI

1. with npm:

   npm install -g gearup

2. with yarn:

   yarn add global gearup

Usage

Basic Commands

1. Install Docker:

   gearup install docker

2. Install Docker Compose:

   gearup install docker-compose

3. Cloudflared Tunnel:

   gearup tunnel

Planned Commands

1. Install curl:

   gearup install curl

2. Install git:

   gearup install git

3. Install nvm:

   gearup install nvm

4. Install zsh:

   gearup install zsh

Contributing

We welcome contributions! To add features or suggest improvements:

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

   git checkout -b feature-new-tool

3. Commit your changes:

   git commit -m "Add support for new tool"

4. Open a pull request.

License

This project is licensed under the MIT License. You can use, modify, and distribute it freely, provided attribution is given.