README.md

🎯 Motivation

Developed by the AI Verify Foundation, Moonshot is one of the first tools to bring Benchmarking and Red-Teaming together to help AI developers, compliance teams and AI system owners evaluate LLMs and LLM-based AI systems.

Project Moonshot's UI is designed to provide a more intuitive user experience for benchmarking and red teaming processes via Moonshot Library.

You can view the Project Moonshot Library Repository here.

🎥 Preview:

Getting Started

✅ Prerequisites

1. Git Version Control: Git is essential for cloning the repository.

2. Node.js: Node.js verion 20.11.1 LTS and above

3. Moonshot: Moonshot Python Library

⬇️ Installation

If you already have installed the Moonshot Python Library, simply run

python -m moonshot -i moonshot-ui

Else, to install and build from source:

1. Download Moonshot UI from GitHub.

   git clone git@github.com:moonshot-admin/moonshot-ui.git
   

2. Install Required Dependencies

• Make sure that all requirements are installed by executing the following command:

  npm install --omit=dev
  

3. From the project root folder, execute the following command:

   npm run build
   

🖼️ Serving Moonshot UI

After the build is completed, serve the UI with this command:

python -m moonshot web

Access the Web UI from browser http://localhost:3000

Alternatively, to manually start up the Web UI, you can run:

npm start

⚠️ You will need to have test assets from moonshot-data before you can run any tests.

Check out our Installation Guide for more details.

If you have installation issues, please take a look at the Troubleshooting Guide.

📚 User Guides

Getting Started with Moonshot Web UI