Skip to content

Lorydima/MindCLI

MindCLI V1.0

MindCLI_V1.0_README_Img

ℹ️ Repository Info

GitHub stars GitHub repo size Platform: Windows Platform: Linux via Wine macOS Support

GitHub last commit GitHub version GitHub Pull Requests GitHub Issues

Contributions welcome License: GPL-3.0

🎲 Features

Img Feature Description
Powerful Chat Mode: Easy and useful commands with text formatting that improve interaction with AI models.
Easy Commands: Simple commands which allow for much simpler use and control of AI in a CLI.
GGUF Compatibility: Supports all AI models in .gguf format from Hugging Face.
Privacy & Productivity: Runs AI models offline, ensuring a privacy-first experience.
Complete Model Control: Control over basic prompts, parameters, and hardware modes.
Ethical AI Usage: The developer encourages everyone to use AI models responsibly and ethically.

📁 Project Structure

MindCLI/
├── src/                               # Application source code
│   └── mindcli/                       # Main application package
│       ├── main.py                    # Application entry point
│       ├── config.py                  # Configuration management
│       ├── ai_engine.py               # AI model interaction
│       ├── ui.py                      # Terminal UI components
│       ├── utils.py                   # Helper functions
│       │
│       └── assets/                    # Application assets
│           ├── MindCLI.ico            # Application icon
│           ├── MindCLI.png            # Application logo
│           └── MindCLI_HELP.txt       # Help documentation
│
├── docs/                              # Website Source Code
│   ├── index.html                     # Website main page
│   ├── style.css                      # Website styling
│   └── ...                            # Website assets (images, ico)
│
├── LICENSE.txt                        # GNU GPL v3 License
├── README.md                          # Project overview 
├── CHANGELOG.md                       # Version history
├── CONTRIBUTING.md                    # Contribution guidelines
├── pyproject.toml                     # Project metadata and build config
├── SECURITY.md                        # Security Policy
└── requirements.txt                   # External dependencies

About assets:
Assets (icons and help files) are stored inside the package so the application can find them when run from source or packaged.

About the docs/ folder:
The docs/ folder contains the source code for the project's website. It is not required to run the application locally.

🌐 MindCLI Website

MindCLI_Website_Img You can access the MindCLI Website from this link: MindCLI Website

💾 Download MindCLI

To download MindCLI v1.0 follow this link, the software is for Windows OS, for linux use Wine: Download MindCLI v1.0

For macOS
The EXE file is not available. However, the application can be run from source by executing the main.py file, provided that Python and the required dependencies are installed.

Warning

For proper program execution, please read the notes below

Do not delete the .json, .txt files or the Models folder in the program directory; they are required for the program to function correctly.

🔗 Clone Repository

Follow these steps:

git clone https://github.com/Lorydima/MindCLI.git
pip install -r requirements.txt
run main.py

🛠️ Bug reports and issues

I do my best to keep this project stable and reliable, but bugs can still happen. If you spot any issues or errors, feel free to open a GitHub issue. Your feedback really helps me improve the project.

📄 License

Before you use the software please read the GNU GPL v3 license at this link: License

About

AI Offline Engine on powerful and easy to use CLI

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors

Languages