Skip to content

dadiaomengmeimei/OpenShrimp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🦐 OpenShrimp

An open-source AI-powered App Store platform.
Describe your app in one sentence, and AI generates the full-stack code instantly.
Create, manage, publish, and share AI applications β€” all from a single platform.

License badge Last Commit badge Issues badge Stars badge

OpenShrimp Banner

Table of contents

TOC


πŸ“Ί Demo

OpenShrimp Demo

Generate an app with one sentence Edit an app with natural language

Back to top

✨ Features

OpenShrimp turns natural language into fully functional AI-powered web applications. No boilerplate, no scaffolding β€” just describe what you want.

πŸ€– One-Sentence App Generation

Describe your app idea in a single sentence, and OpenShrimp's coding agent generates the entire full-stack application β€” backend API routes, frontend UI, and database logic β€” all in seconds.

One-Sentence Generation

Back to top

✏️ Natural Language App Editing

Already have an app? Tell OpenShrimp what to change in plain language. The AI agent reads your existing code, understands the context, and applies precise modifications β€” adding features, fixing bugs, or refactoring.

Natural Language Editing

Back to top

πŸ”§ Auto-Fix (Error & Behavior)

When an app crashes, OpenShrimp automatically catches the runtime error and offers one-click Auto-Fix. The agent reads the traceback, analyzes root cause, locates the buggy code, and applies a surgical fix β€” all without you touching a single line of code.

Even when there's no crash but the output is simply wrong, you can use Behavior Fix mode: describe what you expected, and the agent compares the actual vs. expected output to understand the gap and rewrite the logic accordingly.

Both modes support real-time supervision β€” you can guide the agent with additional messages during the fix process.

Back to top

🧠 Skills Memory System

After every agent session (generation, editing, or debugging), OpenShrimp automatically extracts reusable skills from the conversation:

  • User preferences β€” what you really wanted, style choices, constraints
  • Debugging lessons β€” errors encountered, root causes, how they were fixed
  • Architecture decisions β€” why certain patterns were chosen
  • Potential extensions β€” features hinted at but not yet built

These skills are persisted per-app and loaded into context for future sessions. The agent gets smarter with every interaction β€” it won't repeat past mistakes and will respect your preferences.

Back to top

πŸͺ App Market

Publish your apps to a shared marketplace. Other users can discover, browse, and add public apps to their own workspace with one click.

App Market

Back to top

πŸ“Š Built-in Apps

Comes with ready-to-use apps out of the box:

  • Excel Analyzer β€” Upload Excel files for AI-powered data analysis, pivot tables, and chart generation
  • RAG Reader β€” Upload documents (PDF, TXT, etc.) for AI-powered reading and question answering with source citations

These built-in apps also serve as reference implementations β€” the coding agent can use them as templates when generating similar applications.

Built-in Apps

Back to top

πŸ› οΈ Agent Toolbox

The coding agent is not just a prompt-to-code generator. It has a full developer toolbox:

Tool Description
ls Browse directories β€” understand project structure
read Read file contents β€” analyze existing code
write Create new files β€” scaffold from scratch
edit Surgical text replacement β€” modify without rewriting
bash Run shell commands β€” test, install deps, check output
update_app_features Toggle UI capabilities (e.g., enable file upload)

The agent uses these tools in an autonomous iterative loop (up to 200 iterations): write code β†’ execute β†’ check errors β†’ fix β†’ repeat β€” just like a real developer.

Back to top

πŸ—œοΈ Context Compression

Long agent sessions don't blow up the token budget. Every 5 iterations, OpenShrimp automatically compresses conversation history into a structured summary, preserving:

  • Original user goal
  • Files created or modified
  • Key decisions made
  • Errors encountered and resolutions
  • Current progress state

This allows the agent to run 200+ iterations on complex tasks without losing context or hitting token limits.

Back to top

πŸ‘οΈ Real-time Supervision

You're always in control. While the agent is running:

  • πŸ“‘ Live SSE Streaming β€” Watch every tool call, file modification, and agent thought in real-time
  • πŸ“ Message Injection β€” Send guidance messages mid-generation (e.g., "don't use that library, use X instead")
  • β›” Interrupt β€” Stop the agent at any point if it's going off track
  • πŸ” Self-Verification β€” After generation, the agent automatically validates app structure, Python syntax, and module imports. If checks fail, it triggers an auto-repair loop.

Back to top

πŸ”Œ Any LLM Provider

Connect to any OpenAI-compatible LLM provider β€” OpenAI, Moonshot (Kimi), DeepSeek, Anthropic Claude, and more. Configure once in .env, and all apps share the same model.

Back to top

πŸ‘₯ Multi-User & Auth

Built-in JWT authentication with user registration, login, and role-based access. Each user has their own app workspace while sharing a common marketplace.

Back to top

πŸš€ Getting Started

Prerequisites

  • Python 3.10+
  • Node.js 18+
  • An API key from any OpenAI-compatible LLM provider

Quick Start

  1. Clone the repository
git clone https://github.com/anthropics/openshrimp.git
cd openshrimp
  1. Configure environment
cp .env.example .env
# Edit .env and fill in your LLM API key and base URL
  1. Install backend dependencies
pip install -r backend/requirements.txt
  1. Install frontend dependencies
cd frontend
npm install
cd ..
  1. Start the backend
uvicorn backend.main:app --host 0.0.0.0 --port 8000 --reload --reload-exclude 'backend/apps/*'
  1. Start the frontend (in a new terminal)
cd frontend
npm run dev
  1. Open your browser at http://localhost:5173

Default admin credentials: admin / admin123

Docker

docker-compose up --build

Configuration

All configuration is managed through the .env file:

Variable Description Example
LLM_PROVIDER LLM provider type openai
LLM_API_KEY Your API key sk-...
LLM_API_BASE API base URL https://api.openai.com/v1
LLM_MODEL Model name gpt-4o
LLM_MAX_TOKENS Max output tokens 20000
PLATFORM_APP_NAME Platform display name OpenShrimp
AUTH_SECRET_KEY JWT secret key (auto-generated if empty)

Back to top

πŸ—οΈ Architecture

openshrimp/
β”œβ”€β”€ backend/
β”‚   β”œβ”€β”€ agent/           # AI coding agent (generates & edits apps)
β”‚   β”‚   └── code_agent.py       # Main agentic loop with tool use
β”‚   β”œβ”€β”€ api/             # Platform REST API routes
β”‚   β”œβ”€β”€ apps/            # Generated sub-apps (each is a FastAPI router)
β”‚   β”œβ”€β”€ config/          # Settings & environment config
β”‚   └── core/            # Shared services (LLM, DB, auth, registry)
β”œβ”€β”€ frontend/
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ pages/       # Login, Home, Market, App pages
β”‚   β”‚   β”œβ”€β”€ components/  # AgentModal, GenericApp, etc.
β”‚   β”‚   └── services/    # API client
β”‚   └── ...
β”œβ”€β”€ data/                # SQLite DB & generated outputs
β”œβ”€β”€ docker-compose.yml
└── .env                 # All configuration lives here

How it works:

  1. User describes an app in the AgentModal (e.g. "Build a todo list with priorities")
  2. The Coding Agent receives the prompt and uses tools (ls, read, write, edit, bash) to scaffold the app
  3. The agent iterates autonomously β€” writing code, running tests, fixing errors β€” up to 200 iterations
  4. Self-verification checks structure, syntax, and imports; auto-repairs if anything fails
  5. A new sub-app directory is created under backend/apps/<app_id>/ with its own isolated .venv
  6. Dependencies are auto-detected and installed; the app is registered and immediately available
  7. Skills are extracted from the session and saved for future context
  8. Users can iterate on the app with natural language edits, or use Auto-Fix for runtime errors

Back to top

🀝 Contributing

Contributions of all types are more than welcome!

  1. ⭐ Star this repo to show your support
  2. πŸ› Report issues and feedback
  3. πŸ”§ Submit pull requests
# Fork & clone
git clone https://github.com/dadiaomengmeimei/OpenShrimp.git

# Create a branch
git checkout -b feat/amazing-feature

# Make your changes, then
git commit -m "feat: add amazing feature"
git push origin feat/amazing-feature

Back to top

πŸ“œ License

MIT Β© OpenShrimp

Back to top

About

An open-source AI App Store β€” describe your app in one sentence, and AI generates the full-stack code instantly. 🦐

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors