|
24 | 24 | <strong>If Zync helps your workflow, please consider giving it a <a href="https://github.com/24kchengYe/Zync/stargazers">Star</a>!</strong> |
25 | 25 | </p> |
26 | 26 |
|
27 | | -## Why Zync? |
| 27 | +## The Problem |
28 | 28 |
|
29 | | -Traditional IDEs give you an editor, a terminal, and a debugger — tools for *writing* code yourself. But in the age of AI coding agents, your job has changed: you're no longer the programmer, you're the **project manager** directing multiple AI agents. |
| 29 | +If you've tried running AI coding agents in VS Code or a regular terminal, you've hit these walls: |
30 | 30 |
|
31 | | -Zync is the workspace for this new workflow: |
| 31 | +**1. One agent at a time.** You give Claude Code a task, then sit and wait. Want to try a different approach? You have to stop the first one, lose its context, and start over. You can't easily compare two solutions side by side. |
| 32 | + |
| 33 | +**2. Agents step on each other's toes.** Open two terminals and run two agents on the same project — they both edit the same files, create merge conflicts, and break each other's work. You spend more time untangling the mess than reviewing the code. |
| 34 | + |
| 35 | +**3. No easy way to review and roll back.** Your agent made 47 file changes. Which ones are good? Which ones broke something? In a terminal, you're running `git diff` manually. In VS Code, the source control panel wasn't designed for reviewing AI-generated bulk changes across branches. |
| 36 | + |
| 37 | +**4. Branching is manual and tedious.** The proper way to isolate parallel work is git worktrees — but creating, managing, and cleaning them up by hand is painful. Most people don't bother, and end up with agents fighting over the same working directory. |
| 38 | + |
| 39 | +**5. No unified view.** With multiple agents across multiple terminals, you're alt-tabbing constantly. There's no single dashboard showing "Agent A is done, Agent B is still running, Agent C needs input." |
| 40 | + |
| 41 | +## How Zync Solves This |
| 42 | + |
| 43 | +Zync handles all of the above automatically: |
32 | 44 |
|
33 | 45 | - **Parallel execution** — Run 10+ AI agents simultaneously, each working on a different task |
34 | | -- **Automatic isolation** — Every agent gets its own git worktree (a full copy of your project), so they never conflict with each other |
35 | | -- **Review & merge** — Built-in diff viewer to inspect what each agent changed, then merge the best results back to your main branch |
36 | | -- **Any agent, any model** — Works with Claude Code, OpenAI Codex, Aider, Goose, or any CLI-based AI coding tool |
37 | | -- **Permission control** — Choose per workspace: let the AI run freely, or require your approval for every action |
38 | | -- **Diff caching** — Intelligent fingerprint-based caching for instant tab switching |
| 46 | +- **Automatic isolation** — Every agent gets its own git worktree. No conflicts, no mess |
| 47 | +- **Built-in diff viewer** — See exactly what each agent changed, with syntax highlighting |
| 48 | +- **One-click merge** — Happy with an agent's work? Merge it back to main. Not happy? Archive it |
| 49 | +- **Any agent, any model** — Claude Code, Codex, Aider, Goose, or any CLI tool |
| 50 | +- **Permission control** — Auto-approve everything, or review each action manually |
| 51 | +- **Notifications** — Get alerted when an agent finishes or needs your input |
39 | 52 |
|
40 | 53 | ## Zync vs Traditional IDEs |
41 | 54 |
|
42 | 55 | | | VS Code / PyCharm | Zync | |
43 | 56 | |---|---|---| |
44 | 57 | | **Who writes code** | You | AI agents | |
45 | 58 | | **Your role** | Programmer | Project manager | |
46 | | -| **Parallel work** | One editor at a time | 10+ agents in parallel | |
| 59 | +| **Parallel work** | One terminal at a time | 10+ agents in parallel | |
47 | 60 | | **Isolation** | Manual branching | Automatic git worktrees | |
48 | | -| **Code review** | External tools (GitHub) | Built-in diff viewer | |
| 61 | +| **Code review** | `git diff` or GitHub PR | Built-in diff viewer | |
49 | 62 | | **Agent support** | Extensions/plugins | Native, any CLI agent | |
| 63 | +| **Workspace management** | You manage branches | Automatic lifecycle | |
50 | 64 |
|
51 | | -> **Note:** Zync and VS Code are complementary, not competing. Use VS Code for writing LaTeX, debugging, and plugins. Use Zync for orchestrating multiple AI agents. Zync has an "Open in IDE" button to jump into VS Code for any workspace. |
| 65 | +> **Zync and VS Code are complementary, not competing.** Use VS Code for writing LaTeX, debugging, and its plugin ecosystem. Use Zync when you want to throw multiple AI agents at a problem and pick the best result. Zync has an "Open in IDE" button to jump into VS Code for any workspace. |
52 | 66 |
|
53 | 67 | ## Workflow |
54 | 68 |
|
@@ -279,9 +293,32 @@ Access via gear icon or `Ctrl + ,`: |
279 | 293 | - PTY terminal type corrected to xterm-256color |
280 | 294 | - Global Claude Code used instead of bundled version |
281 | 295 |
|
282 | | -## Contributing |
| 296 | +## Known Limitations |
| 297 | + |
| 298 | +Zync is purpose-built for AI agent orchestration. It intentionally does **not** try to replace your IDE: |
| 299 | + |
| 300 | +- **No code editor** — Zync has a basic file explorer, but for serious editing you should use VS Code, PyCharm, or your preferred editor. Click "Open in IDE" to jump there. |
| 301 | +- **No debugging tools** — Breakpoints, variable inspection, etc. live in your IDE. |
| 302 | +- **No plugin ecosystem** — VS Code has extensions for every language and framework. Zync focuses on the agent workflow layer. |
| 303 | +- **No syntax intelligence** — No autocomplete, linting, or language server. The AI agents handle that in their own context. |
| 304 | + |
| 305 | +These are deliberate design choices, not missing features. Zync does one thing well: orchestrating AI agents. |
| 306 | + |
| 307 | +## Roadmap & Contributing |
| 308 | + |
| 309 | +We'd love help making Zync better. Here are areas where contributions are especially welcome: |
| 310 | + |
| 311 | +- [ ] Auto-rename workspaces based on AI's actual work content |
| 312 | +- [ ] Performance optimization for large projects (Explorer, Diff) |
| 313 | +- [ ] Plugin system for custom agent integrations |
| 314 | +- [ ] Workspace templates (pre-configured agent + prompt combos) |
| 315 | +- [ ] Session statistics dashboard (tokens used, time spent, etc.) |
| 316 | +- [ ] Conflict resolution UI for merge failures |
| 317 | +- [ ] i18n / localization support |
| 318 | + |
| 319 | +Have an idea or found a bug? [Open an issue](https://github.com/24kchengYe/Zync/issues) — feature requests, bug reports, and PRs are all welcome. |
283 | 320 |
|
284 | | -Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
| 321 | +See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines. |
285 | 322 |
|
286 | 323 | ## License |
287 | 324 |
|
|
0 commit comments