coze-studio README

The project's README from github.com/coze-dev/coze-studio. As one markdown file: README.md.

Image

Coze Studio • Feature list • Quickstart • Developer Guide

License Go Version

English | 中文

What is Coze Studio?

Coze Studio is an all-in-one AI agent development tool. Providing the latest large models and tools, various development modes and frameworks, Coze Studio offers the most convenient AI agent development environment, from development to deployment.

Coze Studio, derived from the "Coze Development Platform" which has served tens of thousands of enterprises and millions of developers, we have made its core engine completely open. It is a one-stop visual development tool for AI Agents that makes creating, debugging, and deploying AI Agents unprecedentedly simple. Through Coze Studio's visual design and build tools, developers can quickly create and debug agents, apps, and workflows using no-code or low-code approaches, enabling powerful AI app development and more customized business logic. It's an ideal choice for building low-code AI products tailored . Coze Studio aims to lower the threshold for AI agent development and application, encouraging community co-construction and sharing for deeper exploration and practice in the AI field.

The backend of Coze Studio is developed using Golang, the frontend uses React + TypeScript, and the overall architecture is based on microservices and built following domain-driven design (DDD) principles. Provide developers with a high-performance, highly scalable, and easy-to-customize underlying framework to help them address complex business needs.

Feature list

Module Feature
Model service Manage the model list, integrate services such as OpenAI and Volcengine
Build agent * Build, publish, and manage agent
* Support configuring workflows, knowledge bases, and other resources
Build apps * Create and publish apps
* Build business logic through workflows
Build a workflow Create, modify, publish, and delete workflows
Develop resources Support creating and managing the following resources:
* Plugins
* Knowledge bases
* Databases
* Prompts
API and SDK * Create conversations, initiate chats, and other OpenAPI
* Integrate agents or apps into your own app through Chat SDK

Quickstart

Learn how to obtain and deploy the open-source version of Coze Studio, quickly build projects, and experience Coze Studio's open-source version.

Environment requirements:

Deployment steps:

  1. Retrieve the source code.

    # Clone code
git clone https://github.com/coze-dev/coze-studio.git

  2. Deploy and start the service. When deploying and starting Coze Studio for the first time, it may take a while to retrieve images and build local images. Please be patient. If you see the message "Container coze-server Started," it means the Coze Studio service has started successfully.

    cd coze-studio
# start service
# for macOS or Linux
make web  
# for windows
cp ./docker/.env.example ./docker/.env
docker compose -f ./docker/docker-compose.yml up

    For common startup failure issues, please refer to the FAQ.

  3. Register an account by visiting http://localhost:8888/sign, entering your username and password, and clicking the Register button.

  4. Configure the model at http://localhost:8888/admin/#model-management by adding a new model. (The image version must be greater than or equal to 0.5.0.)

  5. Visit Coze Studio at http://localhost:8888/.

[!WARNING] If you want to deploy Coze Studio in a public network environment, it is recommended to assess security risks before you begin, and take corresponding protection measures. Possible security risks include account registration functions, Python execution environments in workflow code nodes, Coze Server listening address configurations, SSRF (Server - Side Request Forgery), and some horizontal privilege escalations in APIs. For more details, refer to Quickstart.

Developer Guide

Using the open-source version of Coze Studio

Regarding how to use Coze Studio, refer to the Coze Development Platform Official Documentation Center for more information. Please note that certain features, such as tone customization, are limited to the commercial version. Differences between the open-source and commercial versions can be found in the Feature List.

License

This project uses the Apache 2.0 license. For details, please refer to the LICENSE file.

Community contributions

We welcome community contributions. For contribution guidelines, please refer to CONTRIBUTING and Code of conduct. We look forward to your contributions!

Security and privacy

If you discover potential security issues in the project, or believe you may have found a security issue, please notify the ByteDance security team through our security center or vulnerability reporting email. Please do not create public GitHub Issues.

Join Community

We are committed to building an open and friendly developer community. All developers interested in AI Agent development are welcome to join us!

🐛 Issue Reports & Feature Requests

To efficiently track and resolve issues while ensuring transparency and collaboration, we recommend participating through:

💬 Technical Discussion & Communication

Join our technical discussion groups to share experiences with other developers and stay updated with the latest project developments:

Feishu Group Chat
Scan the QR code below with Feishu mobile app to join:

Image

Discord Server
Click to join: Coze Community

Telegram Group
Click to join: Telegram Group Coze

Acknowledgments

Thank you to all the developers and community members who have contributed to the Coze Studio project. Special thanks:

coze-studio (coze-dev/coze-studio)

Searching Database…

21.7K ·GitHub
Coze-studio
Что это такое?Опенсорсная платформа «всё в одном» для разработки ИИ-агентов: визуальные инструменты для создания, отладки и развертывания ИИ-агентов, приложений и рабочих процессов — без написания кода или с минимумом кода.
Это облачный сервис, куда нужно регистрироваться, или что-то, что я запускаю сам?Вы запускаете его сами: это самостоятельно разворачиваемая веб-платформа, которую вы устанавливаете через Docker Compose — полностью открытый код движка платформы разработки Coze от ByteDance.
Как его запустить?Установите Docker и Docker Compose (минимум 2 ядра CPU и 4 ГБ оперативной памяти), склонируйте репозиторий и запустите сервис через Docker Compose. Первый запуск собирает образы; когда увидите сообщение 'Container coze-server Started', откройте веб-интерфейс и зарегистрируйте аккаунт.
Что нужно настроить, прежде чем я смогу создать агента?Сервис с моделью: после развертывания обязательно добавьте модель (OpenAI, Volcengine и другие), иначе вы не сможете выбирать модели для агентов, рабочих процессов или приложений. Для официальных плагинов также нужны ключи доступа к сторонним сервисам.
Безопасно ли выставлять его в открытый интернет?Будьте осторожны: в README рекомендуется сначала оценить риски безопасности — среди возможных называются открытая регистрация аккаунтов, выполнение Python-кода в узлах рабочих процессов, SSRF и некоторые варианты горизонтального повышения привилегий в API.
Можно ли строить что-то без программирования?Да: агенты, приложения и рабочие процессы создаются визуально — без кода или с минимумом кода. Техническая часть — это установка: сначала кто-то должен развернуть платформу через Docker и настроить сервис с моделью.
Что конкретно я могу в нём создать?Три вещи: агентов, приложения и рабочие процессы. Есть визуальный холст для сборки рабочих процессов перетаскиванием узлов, а также общие ресурсы — плагины, базы знаний, базы данных и промпты.
Могу ли я встроить созданных агентов в свой продукт?Да — Coze Studio предоставляет OpenAPI для чатов и рабочих процессов, а также Chat SDK с авторизацией через Personal Access Token, поэтому агентов можно интегрировать в свои приложения (в README показан пример веб-клиентской поддержки).
Чем он отличается от коммерческой платформы Coze?Основной движок полностью открыт, но некоторые функции доступны только в коммерческой версии — в примере приводится настройка tone (стиля общения). Полный список отличий расписан в документации.
Что у него под капотом?Бэкенд на Golang и фронтенд на React + TypeScript, организованные как микросервисы по принципам domain-driven design. В основе лежат рантайм Eino, движок визуальных рабочих процессов FlowGram и Go-фреймворк Hertz.
What are similar projects?sim, JeecgBoot, nocobase, FastGPT, kestra, Flowise, dify, LoomFlow
Which topics is it in?coze, chatbot-framework, low-code, no-code, workflow, knowledge-base, chatbot, rag, generative-ai, docker-compose, go, agent
Creator
coze-dev
Size
73.7 MB
Stars
21.7K
Updated
CommitJul 29Releasev0.5.1Feb 05
Age
1y
Commits · 90 Days