Quick Start Guide

This guide will help you get up and running with AIGuardian in just a few minutes.

Prerequisites

• Node.js 14.x or higher

• npm 6.x or higher

Installation

Install AIGuardian globally using npm:

bash
npm install -g aiguardian

Basic Usage

Step 1: Navigate to Your Project

Open a terminal and navigate to the root directory of your project:

bash
cd path/to/your/project

Step 2: Run AIGuardian

Run AIGuardian with the default settings:

bash
aiguardian

AIGuardian will automatically:

1. 1. Detect your project type

1. 2. Identify available optimization tasks

1. 3. Display a list of recommended tasks

Step 3: Select Tasks to Run

When prompted, select the tasks you want to run:

? Select tasks to run: (Use arrow keys and space to select)
❯◯ Clean temporary files
 ◯ Normalize line endings
 ◯ Optimize .gitignore
 ◯ Format code

Press Enter to run the selected tasks.

Common Commands

Run All Tasks

To run all available tasks for your project:

bash
aiguardian --all

Dry Run

To preview changes without applying them:

bash
aiguardian --dry-run

Specific Tasks

To run specific tasks:

bash
aiguardian --tasks clean-temp,format-code

Next Steps

• Read the Project Overview to understand AIGuardian's architecture
• Check the Configuration guide to customize AIGuardian for your project
• Visit the Command Reference for a complete list of commands and options