Getting Started with AIGuardian (v1.1.0)

This guide will walk you through setting up and using AIGuardian in the simplest way possible.

What is AIGuardian?

AIGuardian is a helpful tool that cleans up and improves your code projects automatically. Think of it like a smart assistant that tidies up your project files.

Installation

Step 1: Make sure you have Node.js installed

AIGuardian needs Node.js to run. If you don't have it already:

1. 1. Go to nodejs.org

1. 2. Download and install the "LTS" (Long Term Support) version

1. 3. Follow the installation instructions for your computer

Step 2: Install AIGuardian

Once Node.js is installed, open your command prompt or terminal and type:

npm install -g aiguardian

Wait for the installation to finish. This might take a minute or two.

Using AIGuardian

Basic Usage

1. 1. Open your command prompt or terminal
1. 2. Navigate to your project folder
- On Windows: use cd your_project_folder_path - On Mac/Linux: use cd your_project_folder_path
1. 3. Run AIGuardian:

   aiguardian
   

What Happens Next

1. 1. AIGuardian will scan your project files
1. 2. It will show you a list of tasks it can perform
1. 3. Use arrow keys to select tasks (press spacebar to select/deselect)
1. 4. Press Enter to confirm your selection
1. 5. AIGuardian will ask for confirmation before making changes
1. 6. Once confirmed, it will clean and optimize your project

Safest Way to Use AIGuardian

If you're worried about changes, use the "dry run" mode:

aiguardian --dry-run

This will show what changes would be made without actually changing anything.

Common Tasks AIGuardian Can Help With

• Removing unnecessary files
• Fixing line endings in text files
• Creating or improving the .gitignore file
• Updating dependencies
• Organizing files

Need Help?

If you encounter any issues or have questions:

1. 1. Check the official AIGuardian documentation
1. 2. Visit the GitHub repository to search for similar issues
1. 3. Ask for help in the discussions section on GitHub
1. 4. Submit a bug report if you've found a new issue

Remember, AIGuardian is designed to help make your coding experience easier!