Your always-on AI coworkers that move between text, calls, and Slack.
TypeScript
docs: present OpenDots as a template and use standard MIT attribution
Jerel John Velardebcb6063bf757
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex a58b931..08d453c 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,6 +1,6 @@# Contributing to OpenDots-OpenDots is in early development. The required foundation is CopilotKit Intelligence, Threads, and Channels SDK. Focus changes on Spaces, Specialist Dots, Dottie-style text and calls, Slack, and inspectable background work. Do not add a silent standalone fallback that bypasses these dependencies.+OpenDots is an application template in early development. Focus changes on Spaces, Specialist Dots, text and calls, Slack, and inspectable background work. Keep the documented SDK integrations functional and report missing configuration clearly.For bugs, include the app mode, Node version, steps to reproduce, expected behavior, and actual behavior. Remove credentials and private page content from logs or screenshots.diff --git a/LICENSE b/LICENSEindex 0c8d9a2..b3bf13d 100644--- a/LICENSE+++ b/LICENSE@@ -1,6 +1,6 @@-MIT License+The MIT License-Copyright (c) 2026 OpenDots contributors+Copyright (c) Atai BarkaiPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to deal@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:-The above copyright notice and this permission notice shall be included in all-copies or substantial portions of the Software.+The above copyright notice and this permission notice shall be included in+all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE-SOFTWARE.+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN+THE SOFTWARE.diff --git a/README.md b/README.mdindex 9961fd1..efe7f99 100644--- a/README.md+++ b/README.md@@ -4,135 +4,99 @@### A little dot. A lot off your plate.-**An open-source work companion built on CopilotKit Intelligence, Threads, and Channels SDK.**+**An open-source template for persistent AI coworkers.**-Organize your work into Spaces. Give Specialist Dots ongoing responsibilities. Pick up the conversation in text, on a call, or in Slack.+Spaces, specialist agents, and conversations that move between text, calls, and Slack.-[Product](#the-product) · [Architecture](#architecture) · [Status](#development-status) · [Contributing](CONTRIBUTING.md)+[Overview](#overview) · [Architecture](#architecture) · [Status](#development-status) · [Contributing](CONTRIBUTING.md)</div>----OpenDots is inspired by [OpenAI Dots](https://help.openai.com/en/articles/20001530-getting-started-with-your-dot), with [OpenMuse](https://github.com/CopilotKit/OpenMuse) and [OpenBot](https://github.com/CopilotKit/openbot) as implementation references. It brings a persistent companion, specialist agents, conversations, and visible work into one interface.+## Overview-> **Under development.** This README defines the product being built. The required CopilotKit integration and the features below are not yet a released, verified application. OpenDots is an independent implementation with its own branding and character.+OpenDots is a starting point for building your own agent workspace. Clone it, define your Dots, connect your services, and adapt the interface and tools to your needs.-## The product+**A template, not a hosted product.** You run the application and configure its infrastructure. The template is under development; the status table below separates implemented work from planned integrations.### Spaces-A Space brings together related work: Specialist Dots, conversations, sources, and results. Move between Spaces without losing the context of the work or which Dot is responsible for it.--Space membership and tool access must be enforced on the server. A sidebar selection is not an authorization boundary.+Group related Dots, conversations, sources, and results in a Space. Keep each area of work organized without losing the context of its conversations.### Specialist Dots-Give each Dot a name, role, instructions, and permitted tools. A researcher can investigate a topic; a writer can turn findings into a draft. Each Dot has a visible status, a durable conversation, and work you can inspect, pause, and resume.--Specialization changes the agent's instructions and capabilities, not just its avatar. Background responsibilities need a running worker and explicit execution controls.--### Dottie-style chat--The conversation is the main workspace:--- A companion avatar and status above the conversation.-- User messages in colored bubbles, with readable assistant replies and work updates.-- Contextual messages that link back to the page or artifact they came from.-- Text and call controls in the same conversation.-- Call receipts in the timeline, including duration and outcome.-- A nearby computer or result panel for inspecting the work.--**Text** runs through CopilotKit and persists in Intelligence Threads. Returning to the app should reopen the same conversation, including its tool activity.+Give each Dot a name, role, instructions, and permitted tools. A researcher can investigate a topic; a writer can turn findings into a draft. Inspect their work and control what they can do.-**Call — RTS + Compute** pairs realtime speech with a separate compute agent. Speech keeps the conversation responsive while the compute agent performs longer work. The call and its resulting work belong to the same conversation. The exact voice service integration is being validated; a microphone icon alone does not constitute a working call.+### Text and calls-### Slack through Channels SDK+A continuous conversation keeps the Dot's avatar and status above the messages, with text and call controls close at hand. Work updates, source links, and call receipts appear in the timeline; a side panel shows results or the agent's computer.-Talk to a Dot from Slack using **`@copilotkit/channels`** and a managed CopilotKit Intelligence connection. The Channels SDK process runs the agent and its tools; Intelligence handles the provider connection and message delivery.+Calls pair realtime speech with a separate compute agent, so the conversation can continue while longer work runs. Both use the same conversation context and tool permissions. Voice integration is still in progress.-Slack identity must map to an authorized application identity and Space. A Slack conversation has its own stable thread; sharing it with a web conversation requires an explicit, authorized association. Display names or matching email addresses are not sufficient account linking.+### Slack-## Required foundation--These are product requirements, not optional enhancements:--| Foundation | Responsibility |-| ------------------------------------ | ------------------------------------------------------------ |-| **CopilotKit Intelligence** | Durable agent infrastructure and managed channel connections |-| **CopilotKit Threads** | Persisted conversations, messages, and agent activity |-| **CopilotKit Channels SDK** | Slack message handling and agent replies |-| **CopilotKit React SDK and runtime** | Web conversation UI, agent execution, and streaming |-| **RTS + Compute** | Realtime calls connected to a separate compute agent |--The application must report missing configuration explicitly. It must not silently substitute local chat storage or an unrelated model endpoint for Intelligence. Test fixtures may simulate dependencies; they are not a standalone product mode.--OpenDots application code is MIT licensed. CopilotKit Intelligence is required infrastructure: use a configured hosted project or a supported self-hosted deployment. Running OpenDots yourself does not remove that requirement. Model, speech, and hosted-service usage may incur separate costs.+Message a Dot through a managed Slack connection using Channels SDK. Explicit identity and Space mappings determine which conversations and tools a Slack user can access.## Architecture+The template uses CopilotKit's React SDK and runtime, Intelligence for durable Threads, and Channels SDK for Slack. Application metadata and background-work state are stored separately from conversation history.+```mermaidflowchart TB- Web["Web app: Spaces, Dots, Dottie chat"] --> Runtime[CopilotKit runtime]- Slack[Slack] <--> Managed[Managed Intelligence connection]- Managed <--> Channels[Channels SDK process]+ Web["Web app: Spaces, Dots, chat"] --> Runtime[CopilotKit runtime]+ Slack[Slack] <--> Managed[Managed channel connection]+ Managed <--> Channels[Channels SDK]Channels --> Agents[Specialist compute agents]Runtime --> Agents- Runtime <--> Intelligence["CopilotKit Intelligence / Threads"]+ Runtime <--> Intelligence["Intelligence / Threads"]Channels <--> Intelligence- Web <--> Speech[Realtime speech session]- Speech --> Bridge[Authorized compute bridge]+ Web <--> Speech[Realtime speech]+ Speech --> Bridge[Compute bridge]Bridge --> Agents- Agents --> Controls[Tool permissions and execution controls]- Controls --> Computer[Isolated browser / compute workspace]- Agents --> Jobs[Durable background work]- Runtime --> Metadata[(Spaces, Dot configuration, work metadata)]+ Agents --> Controls[Tool permissions]+ Controls --> Computer[Isolated browser / workspace]+ Agents --> Jobs[Background work]+ Runtime --> Metadata[(Spaces, Dots, work metadata)]```-Intelligence owns conversation history. The application stores Space and Dot configuration and background-work metadata. A job queue is not a replacement for Threads. Text, Slack, and speech must reach the same permission checks before an agent acts.+You configure the Intelligence project, model provider, and channel connection for your deployment; calls also need a speech provider. Credentials stay on the server. Missing configuration should produce a clear setup state, and test fixtures should remain visibly separate from live integrations.-OpenMuse informs the persistent agent and visible-work experience. OpenBot informs agent-computer isolation and execution controls. Their application-specific channel concepts are distinct from the CopilotKit Channels SDK required here.+[OpenMuse](https://github.com/CopilotKit/OpenMuse) and [OpenBot](https://github.com/CopilotKit/openbot) are code references for persistent work, agent computers, and execution controls. OpenDots can be adapted to your own workflows and deployment choices.## Development status-A local research prototype has been built with persistent tasks, scheduling, memory controls, a separate read-only browser, and a responsive companion UI. It is being migrated to the required architecture before an application release.+A local research prototype includes persistent tasks, scheduling, memory controls, a separate read-only browser, and a responsive companion UI. That work is being integrated into the template's conversation architecture.-| Capability | Status |-| ----------------------------------------------- | ------------------------------------------------------- |-| Product scope and architecture | Defined in this README |-| Persistent research tasks and browser isolation | Implemented in the local prototype; integration pending |-| Required Intelligence runtime and Threads | Integration in progress |-| Spaces and Specialist Dots | Planned implementation |-| Dottie-style text conversation | Reference supplied; implementation pending |-| Slack through Channels SDK | Integration pending |-| Calls with RTS + Compute | Service contract and integration pending |-| End-to-end connected-service verification | Pending configured services |+| Area | Status |+| ------------------------------------------------- | ------------------------------------------------------- |+| Research tasks, scheduling, and browser isolation | Implemented in the local prototype; integration pending |+| Intelligence runtime and Threads | Integration in progress |+| Spaces and Specialist Dots | Implementation in progress |+| Conversation layout and text streaming | Implementation in progress |+| Slack | Integration in progress |+| Realtime calls and compute delegation | Integration in progress |+| Connected-service verification | Pending deployment configuration |-This initial repository milestone is documentation. Application source, reproducible setup commands, and verified dependency versions will follow with the implementation. There is no production-ready deployment or hosted demo to sign up for yet.+This initial repository milestone contains documentation. Application source and reproducible setup instructions will follow with the implementation.-### Implementation sequence+### Next steps-1. Require Intelligence and wire durable Threads into the web runtime.-2. Add persisted Spaces, Specialist Dot configuration, and server-side access checks.-3. Implement the Dottie conversation layout, text streaming, and contextual work panels.-4. Connect Slack through Channels SDK with explicit identity and Space mapping.-5. Add realtime calls, compute delegation, cancellation, and call receipts.-6. Verify background work, service failures, reconnects, and deployment setup.+- Finish conversation persistence and Space/Dot configuration.+- Connect text, Slack, and calls to the same authorized agent tools.+- Verify background execution, cancellation, reconnects, and service failures.+- Document local setup and container deployment.## Contributing-Start with [Contributing](CONTRIBUTING.md). Keep changes focused on the required stack and the workflows above. Distinguish a working integration from a UI fixture, and include setup and verification evidence for new services.--Report security issues using [Security](SECURITY.md). Never include credentials or private conversation content in public issues.+See [Contributing](CONTRIBUTING.md) for development guidance and [Security](SECURITY.md) for reporting issues. Contributions should describe the workflow they enable, include verification evidence, and distinguish live integrations from fixtures.## References-- [OpenAI: Getting started with your dot](https://help.openai.com/en/articles/20001530-getting-started-with-your-dot)-- [CopilotKit Intelligence](https://docs.copilotkit.ai/intelligence/overview)-- [CopilotKit Channels SDK](https://github.com/CopilotKit/channels-sdk)-- [Channels `createChannel` reference](https://docs.copilotkit.ai/reference/channels/functions/createChannel)-- [CopilotKit OpenMuse](https://github.com/CopilotKit/OpenMuse)-- [CopilotKit OpenBot](https://github.com/CopilotKit/openbot)+- [CopilotKit documentation](https://docs.copilotkit.ai/intelligence/overview)+- [Channels SDK](https://github.com/CopilotKit/channels-sdk)+- [OpenMuse](https://github.com/CopilotKit/OpenMuse)+- [OpenBot](https://github.com/CopilotKit/openbot)## Licensediff --git a/SECURITY.md b/SECURITY.mdindex d811766..f738ebb 100644--- a/SECURITY.md+++ b/SECURITY.md@@ -1,6 +1,6 @@# Security-OpenDots is under development. The local prototype is single-owner; Space membership, Slack identity mapping, and voice delegation require additional enforcement before connected multi-user use. It is not a security-audited autonomous agent.+OpenDots is an application template under development, not a hosted service. The local prototype is single-owner; Space membership, Slack identity mapping, and voice delegation require additional enforcement before connected multi-user use. It is not a security-audited autonomous agent.## Intended boundary