minipilot

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 86 Open GitHub ↗

MiniPilot is a GenAI-assisted chatbot backed by Redis. Chat with your documents

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Minipilot

This application implements a chatbot you can train with your data. From the GUI you will be able to:

- Upload CSV data
- Create an index
- Edit the system and user prompt
- Ask questions in natural language

![demo](https://raw.githubusercontent.com/redis/minipilot/main/src/static/images/minipilot.gif)

The system uses:

- Redis Stack as a vector database to store the dataset and vectorize the content for RAG using Redis [vector search capabilities](https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/).
- OpenAI ChatGPT Large Language Model (LLM) [ChatCompletion API](https://platform.openai.com/docs/guides/gpt/chat-completions-api)

## Quickstart

Follow these instructions to build and start Minipilot and a Redis Stack database as containers on your laptop. For more installation methods, refer to the docs.

1. `git clone https://github.com/redis/minipilot.git`
2. `export OPENAI_API_KEY="your-openai-key"`
2. `cd minipilot`
3. `docker compose build --no-cache && docker compose up -d` and wait a couple of minutes until Redis loads the [IMDB movies dataset](https://www.kaggle.com/datasets/ashpalsingh1525/imdb-movies-dataset) in memory
4.  Point your browser to [http://127.0.0.1:5007/](http://127.0.0.1:5007), tune the prompt and start chatting
5. Browse your data with Redis Insight at [http://127.0.0.1:8099](http://127.0.0.1:8099)

## Troubleshooting

For troubleshooting, you can copy the execution log from the container to the host.

```commandline
docker cp minipilot:/app/gunicorn.log .
```

Note that if your OpenAI key is not valid or expired, set the correct key as environment variable and restart the Minipilot container (or rebuild it).

## Documentation
- [Installation Guide](docs/installation.md)
- [Usage Guide](docs/usage.md)
- [API Documentation](docs/api.md)
- [Architecture Overview](docs/architecture.md)
- [FAQ](docs/faq.md)

minipilot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README