Get Started

Install and launch NeuroClaw in a few steps

Install NeuroClaw, launch the agent, and verify the setup from one place.

Start Installation Open README

Requirements

Core

Python >= 3.10 and Git are required.

Optional

Conda or Mamba for isolation, and nvidia-smi or nvcc for GPU support.

Web UI Attachments

Recommended packages include pypdf, python-docx, openpyxl, and python-pptx.

Self-Contained

NeuroClaw is self-contained; OpenClaw does not need to be installed separately.

Installation

Clone and configure

The bundled installer walks you through Python runtime selection, CUDA/GPU configuration, neuroscience toolchain paths, LLM backend selection, default directories, and Web UI dependencies.

Clone the repository.
Run the setup wizard: python installer/setup.py
Use --non-interactive for a quick auto-detected setup.
If needed, install Web UI dependencies manually.

git clone https://github.com/CUHK-AIM-Group/NeuroClaw.git
cd NeuroClaw
python installer/setup.py
python installer/setup.py --non-interactive
pip install "fastapi[standard]" uvicorn pypdf python-docx openpyxl python-pptx

Quick Use

Start NeuroClaw

You can run NeuroClaw either in the terminal REPL or in the browser-based Web UI.

Terminal REPL: python core/agent/main.py
Web UI: python core/agent/main.py --web
Open http://localhost:7080 in your browser.
Use --port and --host for remote access or custom binding.

python core/agent/main.py
python core/agent/main.py --web
python core/agent/main.py --web --port 8080 --host 0.0.0.0

Verify Installation

Use these checks to confirm the environment file and skill registry are working as expected.

# Check that the environment file is valid
python installer/setup.py --check

# List registered neuroscience skills (Python)
python -c "
from core.skill_loader.loader import SkillLoader
from pathlib import Path
skills = SkillLoader(Path('skills')).load_all()
for s in skills:
    print(s['name'])
"

Next Step

Once NeuroClaw is running, you can explore the benchmark, FAQ, and homepage pages directly from the site.

Back to Home NeuroBench Repository