Skip to content

FAQ.md

Latest commit

 

History

History
228 lines (165 loc) · 7.81 KB

FAQ.md

File metadata and controls

228 lines (165 loc) · 7.81 KB
Raw

❓ Frequently Asked Questions (FAQ)

General Questions

What is HelperTools?

HelperTools is a terminal extension toolkit that provides easy-to-use commands for developers. It includes file management, AI assistance, server control, and automation features.

Is HelperTools free?

Yes! HelperTools is open-source and licensed under the MIT License.

What platforms does it support?

Currently Windows (PowerShell and CMD). Linux and macOS support is planned for future releases.

Do I need programming knowledge to use it?

No! HelperTools is designed to be user-friendly. Just type commands and follow the prompts.

Installation Questions

Where should I install HelperTools?

Anywhere you have sufficient disk space. The installer automatically handles alternate drive installations if Drive C is full.

Do I need admin rights to install?

No admin rights required for basic installation. However, modifying system PATH may require admin access depending on your Windows configuration.

What are the system requirements?

  • Windows 7 or later
  • Python 3.8 or higher (required)
  • Node.js 16 or higher (optional, for web features)
  • 100 MB free disk space (minimum)
  • 500 MB recommended (with all dependencies)

Can I install HelperTools on Drive D or F?

Yes! The installer automatically uses your current drive and avoids filling up Drive C.

Usage Questions

How do I start HelperTools?

Simply type hts or helpertools in any terminal after adding it to your PATH.

What's the difference between hts and main.bat?

hts.bat is just a shortcut alias that calls main.bat. They do the same thing.

How do I see all available commands?

Type help when HelperTools is running.

Can I use HelperTools from any directory?

Yes, once you add HelperTools to your PATH environment variable.

How do I exit HelperTools?

Type exit or quit.

AI Assistant Questions

What is HelperToolsAI?

HelperToolsAI is an AI assistant (based on Brahma AI) integrated into HelperTools. It can help with coding, file processing, web browsing, and many other tasks.

Does HelperToolsAI require internet?

Yes, it uses AI providers like DeepSeek, OpenAI, or OmniRoute which require an internet connection and an API key.

How do I set up my own API keys (BYOK)?

HelperTools uses a Bring Your Own Key (BYOK) system. You configure your keys locally:

apikey set deepseek your-deepseek-api-key
apikey active deepseek

What API providers are supported?

  • deepseek — DeepSeek (recommended, strong performance)
  • openai — OpenAI GPT models
  • omniroute — Your personal OmniRoute proxy
  • anthropic — Claude
  • gemini — Google Gemini
  • groq — Groq fast inference
  • openrouter — OpenRouter multi-model
  • custom — Any OpenAI-compatible endpoint

Do my API keys get sent anywhere?

No. Your keys are stored locally only in config/apikeys.json and are never uploaded or shared.

I use OmniRoute, how do I configure it?

apikey set omniroute your-omni-api-key
apikey active omniroute

Then launch HelperToolsAI:

brahma

How do I get an API key?

  1. Visit Google AI Studio: https://makersuite.google.com/
  2. Create an account and generate an API key
  3. Add it to Brahma-AI/config/api_keys.json

Can I use HelperToolsAI on my phone?

Yes! Start it in web mode (brahma web) and connect from your phone's browser using the provided URL.

Why is it called HelperToolsAI instead of Brahma AI?

We renamed it to reflect its integration with HelperTools and its optimized background processing mode.

Server Questions

What's the difference between web server and app server?

  • Web Server (Node.js): Browser-based interface accessible from any device
  • App Server (Python): Desktop GUI application with advanced features

Can I run both servers at the same time?

Yes! They use different ports and don't interfere with each other.

What port does the web server use?

Default is 3000. You can change it in config/settings.json.

Can I access the web server from another computer?

Yes! Use your computer's IP address instead of localhost (e.g., http://192.168.1.100:3000).

How do I stop a running server?

Type server stop in HelperTools.

Troubleshooting

"Command not found" error

Solution: Make sure HelperTools directory is in your PATH environment variable and restart your terminal.

"Python is not installed" error

Solution: Install Python from https://www.python.org/ and make sure to check "Add Python to PATH".

Dependencies installation fails

Solution:

  1. Check your internet connection
  2. Run python -m pip install --upgrade pip
  3. Try install command again
  4. Check logs with logs command

Drive C is full, can't install dependencies

Solution: Run the install command from a drive with more space (e.g., F:\HelperTools\commands\install.bat). The installer automatically uses the current drive.

Web server won't start

Solution:

  1. Check if Node.js is installed: node --version
  2. Check if port 3000 is available
  3. Try changing port in config/settings.json
  4. Check logs: server/web_server/logs/

Brahma AI not responding

Solution:

  1. Check if API key is configured
  2. Check internet connection
  3. Review logs in Brahma-AI/config/logs/
  4. Try restarting: exit and brahma again

Commands are slow

Solution:

  1. Check system resources (RAM, CPU)
  2. Close unnecessary programs
  3. Use web mode for AI instead of desktop mode
  4. Check antivirus isn't blocking HelperTools

Customization Questions

How do I add my own commands?

  1. Create a .bat file in commands/ directory
  2. Name it after your command (e.g., mycommand.bat)
  3. Add your script logic
  4. Use it by typing the command name in HelperTools

Can I change the colors?

Colors are defined using ANSI codes in the batch scripts. Edit the command files to customize colors.

How do I change the default ports?

Edit config/settings.json and modify the server section.

Can I add custom AI skills?

Yes! Add skill definitions to config/skills/ and implement actions in Brahma-AI/actions/.

Advanced Questions

Can I use HelperTools in my CI/CD pipeline?

Yes! HelperTools commands can be called from scripts. Just ensure the PATH is set correctly.

Is there an API I can use?

The web server exposes a REST API. Check server/web_server/server.js for endpoints.

Can I run HelperTools as a service?

Yes, you can use Windows Task Scheduler or NSSM to run servers as services.

How do I backup my configuration?

Copy the config/ directory to a safe location. This includes settings, logs, and saved data.

Can I use HelperTools with WSL?

Yes, but you'll need to adapt the batch scripts to bash scripts. Linux support is planned for future releases.

Contributing Questions

How can I contribute?

See CONTRIBUTING.md for detailed guidelines. Contributions are welcome!

I found a bug, what should I do?

Open an issue on GitHub with:

  • Clear description
  • Steps to reproduce
  • Expected vs actual behavior
  • System information
  • Relevant logs

Can I request features?

Absolutely! Open an issue with the "feature request" label and describe your idea.

Security Questions

Is my data safe?

HelperTools runs locally on your machine. Your data never leaves your computer unless you use features that explicitly require external services (like AI features).

Does HelperTools collect telemetry?

No. HelperTools does not collect any usage data or telemetry.

Are API keys stored securely?

API keys are stored in local JSON files. Keep your config/api_keys.json file secure and never commit it to version control.

Still Have Questions?

  • Check the full documentation: README.md
  • Open an issue on GitHub
  • Check existing issues and discussions
  • Contact the maintainers

Last updated: 2026-07-15