Faq
AIGuardian Documentation
Loading update info...
View on GitHubAIGuardian FAQ (v1.1.0)
Common Questions
What exactly does AIGuardian do to my files?
AIGuardian helps clean up and organize your project files based on what type of project you have. It can remove temporary files, fix formatting issues, and suggest improvements - but it will always ask for your permission first.Will AIGuardian delete my important work?
No! AIGuardian creates a backup before making any changes. If anything goes wrong, you can restore your files from the backup. Also, if you use the--dry-run
option, it will show what would change without actually changing anything.Do I need to know programming to use AIGuardian?
No special programming knowledge is needed. AIGuardian is designed to be helpful for everyone, from beginners to experts. Just follow the prompts on screen.Will AIGuardian work with my AI-generated code?
Yes! In fact, AIGuardian is especially helpful for organizing and cleaning up code that was generated by AI tools like ChatGPT or Copilot.What project types does AIGuardian support?
AIGuardian works with many project types including:- JavaScript and TypeScript projects
- Python projects
- Java projects
- And more!
What if I don't know what type of project I have?
Don't worry! AIGuardian automatically detects your project type by scanning your files. You don't need to specify anything.Is it safe to use AIGuardian on my work computer?
Yes, AIGuardian is safe to use. It doesn't send your code anywhere, and it creates backups before making changes.How often should I run AIGuardian?
You can run AIGuardian:- After getting code from an AI tool
- When your project feels messy
- Before sharing your code with others
- Anytime you want to clean things up
What if AIGuardian makes a change I don't like?
If you don't like a change, you can restore from the backup that AIGuardian creates. The backup can be found in the.aiguardian/backups
folder in your project.Do I need to be online to use AIGuardian?
No, once AIGuardian is installed, it works completely offline.About Version 1.1.0
What's new in version 1.1.0?
Version 1.1.0 includes several improvements:- Task Registry Improvements: Better handling of project types and task registration
- Test Suite Enhancements: Comprehensive test coverage for core functionality
- Dependency Optimization: Removed unused dependencies for a leaner package
- Command Line Options: Added new options like --yes, --task, and --all for more flexibility
Does AIGuardian have external dependencies?
AIGuardian is designed to be lightweight and only uses native Node.js modules with the exception of 'chalk' for colorful terminal output.How do I run a specific task?
You can run a specific task using the --task option:
aiguardian --task clean-gitignore
How do I run all tasks without confirmation?
You can run all tasks without confirmation using:
aiguardian --all --yes
Was this page helpful?
On This Page
Common QuestionsWhat exactly does AIGuardian do to my files?Will AIGuardian delete my important work?Do I need to know programming to use AIGuardian?Will AIGuardian work with my AI-generated code?What project types does AIGuardian support?What if I don't know what type of project I have?Is it safe to use AIGuardian on my work computer?How often should I run AIGuardian?What if AIGuardian makes a change I don't like?Do I need to be online to use AIGuardian?About Version 1.1.0What's new in version 1.1.0?Does AIGuardian have external dependencies?How do I run a specific task?How do I run all tasks without confirmation?