mindroot

(โ˜… 96)

AI agent web app platform

Showing a partial file list โ€” download the zip above to see everything.

  • .dockerignore
  • .env.example
  • .env.tui.example
  • .gitignore
  • agents.md
  • ahp.py
  • api.md
  • CANCELLATION_IMPLEMENTATION.md
  • check-optimization-status.sh
  • checklistsample.md
  • diagnose-vps-environment.sh
  • docker-compose.yml
  • Dockerfile
  • EMAIL_SETUP_GUIDE.md
  • entrypoint.sh
  • fix-optimization-issues.sh
  • frontend.md
  • generate_credentials.sh
  • GMAIL_CUSTOM_DOMAIN_SETUP.md
  • install.sh
  • L8N_INTEGRATION_GUIDE.md
  • LICENSE
  • MANIFEST.in
  • mr_agent_expert_instr.py
  • mr_api_example.php
  • NETWORK_OPTIMIZATION_README.md
  • optimize-network-latency.sh
  • pluginlist.md
  • plugins.md
  • publish.sh
  • pyproject.toml
  • README.docker.md
  • README.md
  • requirements.txt
  • setup-low-latency-vps.sh
  • TUI_GUIDE.md
  • XML_STREAM_HANDOFF.md
  • XML_STREAMING_HANDOFF.md

# Installation Guide

1. Get the code
git clone https://github.com/runvnc/mindroot

Downloads the entire project code from GitHub to your computer.

cd mindroot

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install mindroot

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install mrsdk

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd mindroot-11.20.0/src/mindroot/coreplugins/admin/static/js/lit-html

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m venv .venv

Runs the Python script (or module).

pip install mindroot

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install mrsdk

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation