OpenGenerativeUI
Open-Source Generative UI Framework
File Explorer
Download Latest Version (.zip)- demo-gallery.md
- handoff.md
- self.findings.md
- ci.yml
- SKILL.md
- SKILL.md
- SKILL.md
- anthropic_compat.py
- bounded_memory_saver.py
- db.csv
- form.py
- model.py
- plan.py
- prompt.py
- query.py
- templates.py
- todos.py
- __init__.py
- test_anthropic_compat.py
- test_canonical_contract.py
- test_middleware_context.py
- test_model.py
- test_skills_contract.py
- test_smoke.py
- .gitignore
- langgraph.json
- main.py
- pyproject.toml
- uv.lock
- file.svg
- globe.svg
- next.svg
- vercel.svg
- window.svg
- no-legacy-rails.test.ts
- route.ts
- route.ts
- route.ts
- route.ts
- store.ts
- page.tsx
- globals.css
- layout.tsx
- page.tsx
- category-filter.tsx
- demo-card.tsx
- demo-data.ts
- grid-icon.tsx
- index.tsx
- index.tsx
- export-utils.test.ts
- bar-chart.tsx
- config.ts
- pie-chart.tsx
- open-generative-ui-renderer.test.tsx
- process-partial-html.test.ts
- frame-content.ts
- index.tsx
- process-partial-html.ts
- renderer.tsx
- schema.ts
- websandbox-loader.ts
- websandbox.d.ts
- export-overlay.tsx
- export-utils.ts
- idiomorph-inline.ts
- meeting-time-picker.tsx
- plan-card.test.tsx
- plan-card.tsx
- index.tsx
- seed-templates.test.ts
- index.tsx
- seed-templates.ts
- template-card.tsx
- template-chip.tsx
- desktop-tip-modal.tsx
- explainer-cards.tsx
- tool-rendering.tsx
- use-generative-ui-examples.test.tsx
- index.ts
- use-example-suggestions.tsx
- use-generative-ui-examples.tsx
- use-theme.tsx
- copilotkit-runtime-options.test.ts
- prompt-bridge.test.tsx
- sandbox-functions.test.ts
- prompt-bridge.tsx
- sandbox-functions.ts
- a2ui-theme.css
- copilotkit-runtime-options.ts
- eslint.config.mjs
- next.config.ts
- package.json
- postcss.config.mjs
- tsconfig.json
- vitest.config.ts
- agent-skills-vol2.txt
- master-agent-playbook.txt
- svg-diagram-skill.txt
- index.ts
- renderer.ts
- server.ts
- skills.ts
- stdio.ts
- renderer.test.ts
- skills.test.ts
- .dockerignore
- .env.example
- .gitignore
- Dockerfile
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- Dockerfile.app
- agent-state.md
- agent-tools.md
- architecture.md
- bring-to-your-app.md
- deployment.md
- generative-ui.md
- getting-started.md
- human-in-the-loop.md
- mcp-integration.md
- README.md
- design-skill.test.ts
- design-system.test.ts
- single-source.test.ts
- index.ts
- .gitignore
- package.json
- tsconfig.json
- vitest.config.ts
- .dockerignore
- .env.example
- .gitignore
- CLAUDE.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- LICENSE
- Makefile
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- render.yaml
- turbo.json
# Installation Guide
1. Get the code
git clone https://github.com/CopilotKit/OpenGenerativeUI
Downloads the entire project code from GitHub to your computer.
cd OpenGenerativeUI
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- 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 build -f apps/mcp/Dockerfile -t opengenerativeui .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 opengenerativeui
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
cd apps/mcp && pnpm dev
Moves into the project folder you just downloaded.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
4. Python
EasyPrerequisites
β οΈ 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.
pip install .
Installs the package published on PyPI directly β no need to clone the source.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make setup # Install deps + create .env template
Compiles the code based on the generated build configuration to produce an executable.
make dev # Start all services
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)