|
1 | 1 | # Mindwire |
2 | 2 |
|
3 | | -**One agent. Bring your subscriptions.** |
| 3 | +**Your product. Powered by agents.** |
4 | 4 |
|
5 | | -Mindwire is your personal agent for everyday work and coding. Bring your supported AI |
6 | | -subscriptions, connect your computer, and put it to work from your Mac, iPhone or iPad. |
| 5 | +Mindwire is an open-source SDK and runtime for building products that can create things and |
| 6 | +carry out work. Connect agents like Codex, Claude Code, and OpenCode to your application's |
| 7 | +tools, files, and knowledge. Give them a goal. Present the work in your own interface, under |
| 8 | +your own brand. |
7 | 9 |
|
8 | | -- **Get everyday work done.** Organize files, process data, prepare documents, and automate repetitive tasks. |
9 | | -- **Build from anywhere.** Write and review code, manage projects, and use a full terminal. |
10 | | -- **Keep work moving.** Start a task, close the app, and come back to the result while your computer stays online. |
11 | | -- **Stay in control.** Follow progress, answer questions, and approve actions along the way. |
12 | | -- **Work where you want.** Use your computer, a server, or a cloud workspace. |
| 10 | +Build on agents that already know how to plan, write code, use tools, and execute tasks. |
| 11 | +Focus on the experience only your product can offer. |
13 | 12 |
|
14 | | -[Download for Mac](https://github.com/oblien/mindwire/releases/latest/download/Mindwire.dmg) · |
15 | | -[Get started](https://mindwire.sh/get-started) · [Documentation](https://mindwire.sh/docs) · |
16 | | -[Account & Cloud portal](https://console.mindwire.sh) |
| 13 | +[Website](https://mindwire.sh) · [Quickstart](https://mindwire.sh/docs/guides/quickstart) · |
| 14 | +[Documentation](https://mindwire.sh/docs) · [TypeScript SDK](packages/sdk) · |
| 15 | +[Go SDK](packages/daemon/sdk) |
17 | 16 |
|
18 | | -[Development](CONTRIBUTING.md) · [Runtime installation](https://mindwire.sh/docs/guides/destinations) · |
| 17 | + |
| 18 | + |
| 19 | +*The [homepage demo](https://mindwire.sh/#in-action) illustrates one request becoming a complete |
| 20 | +project. Its build sequence is simulated; the page, poster, and task-plan outputs work and can |
| 21 | +be downloaded.* |
| 22 | + |
| 23 | +## Build things your users can use |
| 24 | + |
| 25 | +Bring the tools and source material. Let users ask for an outcome inside your product: |
| 26 | + |
| 27 | +- **A brief becomes a launch.** Build a responsive website, create campaign files, and prepare |
| 28 | + an assigned rollout plan. |
| 29 | +- **Data becomes a working tool.** Turn a spreadsheet into an interactive dashboard or a small |
| 30 | + application your users can explore and use. |
| 31 | +- **Research becomes a finished artifact.** Work through documents, compare findings, and |
| 32 | + produce a report, presentation, or export grounded in the supplied material. |
| 33 | +- **A request becomes completed work.** Plan the steps, edit files, run checks, call your |
| 34 | + application's tools, and bring the results back into its workspace. |
| 35 | + |
| 36 | +These are experiences you build on Mindwire. Your application supplies the tools, context, |
| 37 | +permissions, and interface that make them useful. |
| 38 | + |
| 39 | +## Your brand, tools, and way of working |
| 40 | + |
| 41 | +| Capability | What it gives your product | |
| 42 | +| --- | --- | |
| 43 | +| **Your interface** | Embed agent work in your editor, dashboard, app builder, or workspace. Your users stay in your product. | |
| 44 | +| **Your tools** | Connect product operations through MCP: read data, create resources, update projects, and save results. | |
| 45 | +| **Your context and goals** | Supply files, knowledge, instructions, and skills that shape how the work gets done. | |
| 46 | +| **Live progress** | Stream text, tool activity, native task events, and results through a shared event format. | |
| 47 | +| **Human input** | Present supported questions and approvals in your own UI, and cancel work when needed. | |
| 48 | +| **Sessions and automation** | Keep conversation history, resume supported sessions, and start work on demand, on a schedule, or from your backend. | |
| 49 | + |
| 50 | +Mindwire manages native agent connections, execution, authentication, and event translation. |
| 51 | +You decide what the product can do and how people use it. Capabilities vary by agent; |
| 52 | +[the compatibility guide](packages/daemon/HARNESSES.md) documents the supported surfaces. |
| 53 | + |
| 54 | +## Start building |
| 55 | + |
| 56 | +```sh |
| 57 | +npm install mindwire |
| 58 | +``` |
| 59 | + |
| 60 | +The TypeScript SDK starts a local runtime for you on a server runtime such as Node.js or Bun. |
| 61 | +Set up and [authenticate your chosen agent](https://mindwire.sh/docs/guides/authentication), |
| 62 | +then run this from a project containing `launch-brief.md` and its source assets: |
| 63 | + |
| 64 | +```ts |
| 65 | +import { Mindwire } from "mindwire"; |
| 66 | + |
| 67 | +const mw = new Mindwire({ agent: "codex" }); |
| 68 | + |
| 69 | +try { |
| 70 | + const run = await mw.turn({ |
| 71 | + chatId: "launch-project", |
| 72 | + cwd: process.cwd(), |
| 73 | + message: |
| 74 | + "Read launch-brief.md and the supplied assets. Build a responsive landing " + |
| 75 | + "page, create an SVG campaign poster, and write an assigned launch plan. " + |
| 76 | + "Save the results in ./output and check your work.", |
| 77 | + }); |
| 78 | + |
| 79 | + for await (const event of run) { |
| 80 | + if (event.type === "text") process.stdout.write(event.text ?? ""); |
| 81 | + if (event.type === "tool_use") console.log("Tool:", event.tool?.name); |
| 82 | + } |
| 83 | + |
| 84 | + await run.wait(); // Surface a failed or cancelled outcome. |
| 85 | +} finally { |
| 86 | + await mw.close(); |
| 87 | +} |
| 88 | +``` |
| 89 | + |
| 90 | +Use the same execution model through the [Go SDK](packages/daemon/sdk) or |
| 91 | +[REST API](https://mindwire.sh/docs/reference/rest/turns-runs/post-turns). Add your |
| 92 | +[product tools](https://mindwire.sh/docs/guides/mcp), route |
| 93 | +[questions and approvals](https://mindwire.sh/docs/guides/interaction) into your UI, and stream |
| 94 | +the work back to your users. The [quickstart](https://mindwire.sh/docs/guides/quickstart) covers setup. |
| 95 | + |
| 96 | +## Native agents, one integration |
| 97 | + |
| 98 | +Adapters are included for **Codex, Claude Code, OpenCode, Grok, Cursor, and Antigravity**. |
| 99 | +Each uses its native protocol behind the shared SDK and runtime API. Select the agent per |
| 100 | +client or per task, with the authentication methods and capabilities that agent supports. |
| 101 | + |
| 102 | +Cursor and Antigravity are newly added adapters; authenticated model-turn and OAuth |
| 103 | +qualification is still in progress. See [versions, capabilities, and validation](packages/daemon/HARNESSES.md) |
| 104 | +before choosing an adapter for production. |
| 105 | + |
| 106 | +## Build, run, and use Mindwire |
| 107 | + |
| 108 | +| Part | Purpose | |
| 109 | +| --- | --- | |
| 110 | +| **[SDKs and runtime](https://mindwire.sh/sdk)** | The foundation for your own agent-powered product. TypeScript, Go, and REST. | |
| 111 | +| **[Cloud](https://mindwire.sh/cloud)** | Optional Cloud Computer hosting. You can also run locally, on a server, or in a container you manage. | |
| 112 | +| **[Mindwire app](https://mindwire.sh/app)** | A first-party Mac, iPhone, and iPad client built on the same runtime, with General and Developer experiences. | |
| 113 | + |
| 114 | +Your integration does not require the Mindwire app or Cloud. Agent access comes from the |
| 115 | +account or API credentials supported by the selected provider. Scheduled work runs while |
| 116 | +its runtime host remains available. |
| 117 | + |
| 118 | +## Develop and contribute |
| 119 | + |
| 120 | +[Contributing and local development](CONTRIBUTING.md) · |
| 121 | +[Runtime internals](https://mindwire.sh/docs/concepts/internals) · |
| 122 | +[Runtime destinations](https://mindwire.sh/docs/guides/destinations) · |
19 | 123 | [SaaS source deployment](docker/README.md) |
20 | 124 |
|
21 | | -Runtime and SDKs: Apache-2.0. Apple app: source-available. [License details](LICENSING.md). |
| 125 | +## License |
| 126 | + |
| 127 | +The runtime, SDKs, website, and Console are **Apache-2.0**. The Apple app is **source-available** |
| 128 | +under its own license. Independently written products can use the open-source SDKs and runtime. |
| 129 | +See [license details](LICENSING.md). |
0 commit comments