From fa1fba7b9746b0462d16bbddb9bf7cac527ada2a Mon Sep 17 00:00:00 2001 From: David Kaya Date: Mon, 23 Mar 2026 21:43:00 +0100 Subject: [PATCH] docs: add user-facing readme Create a product-focused README for people using Kopaya, keep the copy high-level, and feature the app logo prominently at the top. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e9c5a8 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +

+ Kopaya logo +

+ +

Kopaya

+ +

+ A desktop workspace for Copilot-powered work across real projects. +

+ +Kopaya is built for people who want more than a generic AI chat window. It gives you a place to ask quick questions, connect real projects, run reusable agent patterns, and keep ongoing work organized in one app. + +It works especially well when you want AI help that stays grounded in an actual codebase: your folders, your repository state, your current branch, and your active work. + +## Why use Kopaya? + +- **Start fast** with a scratchpad conversation for quick questions and ad-hoc work. +- **Work against real projects** by attaching local folders and letting Kopaya stay aware of repository context. +- **Go beyond one assistant** with orchestration patterns such as single-agent, sequential, concurrent, handoff, and group-chat flows. +- **See what is happening** with live activity for each agent while a run is in progress. +- **Stay organized** with persistent sessions you can rename, pin, archive, and return to later. +- **Tune how you work** by choosing models and reusing saved patterns that fit different tasks. + +## What you can do in the app + +### Ask quick questions in a scratchpad + +If you just want to think through an idea, draft something, or ask for help without connecting a project, start a scratchpad session and begin chatting. + +### Connect a real project + +Add a local folder when you want help that is grounded in your work. Kopaya is designed to feel strongest when it is attached to a real project instead of acting like a general-purpose chatbot. + +### Choose how agents collaborate + +Kopaya supports several ways of working: + +- **Single** for direct one-agent help +- **Sequential** for step-by-step specialist workflows +- **Concurrent** for parallel exploration +- **Handoff** for agent-to-agent delegation +- **Group chat** for collaborative multi-agent discussion + +### Watch runs as they happen + +You can follow agent activity while a session is running, which makes longer or more complex workflows easier to trust and understand. + +### Keep important work around + +Sessions are persistent, so you can return to ongoing work instead of starting from scratch every time. You can also rename, pin, archive, and duplicate sessions as your workspace grows. + +## Before you start + +To use Kopaya comfortably, make sure you have: + +- a **Windows machine** +- **GitHub Copilot CLI** installed and available as `copilot` +- an active **GitHub Copilot sign-in** +- a local folder or git repository ready to connect if you want project-aware help + +Kopaya includes connection status in the app so you can quickly tell whether Copilot is ready before you start a session. + +## Getting started + +1. **Open Kopaya** + Launch the app and head to settings if you want to confirm your Copilot connection first. + +2. **Check that Copilot is ready** + Make sure the app shows that Copilot is installed and authenticated. + +3. **Choose how you want to begin** + Start a scratchpad session for quick work, or add a project if you want the conversation grounded in a local codebase. + +4. **Pick a pattern** + Use a simple single-agent setup to begin, or choose a saved multi-agent pattern when you want a more structured workflow. + +5. **Start working** + Ask a question, describe a task, or explore a project. As the run progresses, you can watch the participating agents and keep the session for later. + +## When Kopaya feels most useful + +Kopaya shines when you want to: + +- move from quick chat to deeper multi-step work without leaving the app +- keep AI conversations tied to actual projects instead of isolated prompts +- compare different ways of approaching the same task +- reuse patterns for recurring workflows +- maintain a history of meaningful sessions instead of disposable chats + +## Current focus + +Kopaya is focused on local, project-based work with your GitHub Copilot account. It already covers the essentials for working with projects, sessions, and reusable orchestration patterns, and it is growing toward a fuller AI workstation experience over time. + +If you want an AI app that feels closer to a control room for real work than a blank chat box, Kopaya is built for that.