| @@ -9,11 +9,11 @@ |
| 9 | | 9 | |
| 10 | A desktop application to talk with AI agents in channels, for people who are not developers. Agents are reached through the [Agent Client Protocol](https://agentclientprotocol.com) (ACP), so any ACP agent can join. Built with Go and [Wails v3](https://wails.io), interface in Svelte 5. | 10 | A desktop application to talk with AI agents in channels, for people who are not developers. Agents are reached through the [Agent Client Protocol](https://agentclientprotocol.com) (ACP), so any ACP agent can join. Built with Go and [Wails v3](https://wails.io), interface in Svelte 5. |
| 11 | | 11 | |
| 12 | -> **Status — version 0.1, the first release**: packages for macOS (Apple Silicon) and Windows (x86-64 and Arm); an assistant adds agents (on this computer, in Docker or in an sbx sandbox) without writing YAML; channels kept from one launch to the next, several agents per channel with `@` mentions, agent commands with `/`, direct conversations, each agent's folder with an editor and a terminal; answers stream as Markdown with coloured code, tool calls ask permission in plain words, errors say what to do, and a command palette (⌘K) and shortcuts drive it from the keyboard. Backlog and roadmap: `.tickets/` (IssueSpec). | 12 | +> **Status — version 1.0.0**: packages for macOS (Apple Silicon, signed and notarized by Apple since `v1.0.0-macos`) and Windows (x86-64 and Arm); an assistant adds agents (on this computer, in Docker or in an sbx sandbox) without writing YAML, and fills itself in from a dropped `compose.yaml`, `sbxenv.yaml` or agent configuration; a stopped or removed container or sandbox comes back by itself; channels kept from one launch to the next, several agents per channel with `@` mentions, agent commands with `/`, files joined with `$` or by drag and drop, direct conversations, each agent's folder with an editor, a preview of documents and images, protected files and a terminal; answers stream as Markdown with coloured code, tool calls ask permission in plain words, errors say what to do, a Danger zone starts again from scratch, and a command palette (⌘K) and shortcuts drive it from the keyboard. What changed: [release notes](docs/release-notes/). Backlog and roadmap: `.tickets/` (IssueSpec). |
| 13 | | 13 | |
| 14 | **Install**: download the package for your system from the [releases](https://rickub.com/bots-garden/sidekicks/releases), then follow [How to install Sidekicks](docs/en/how-to/install-sidekicks.md). | 14 | **Install**: download the package for your system from the [releases](https://rickub.com/bots-garden/sidekicks/releases), then follow [How to install Sidekicks](docs/en/how-to/install-sidekicks.md). |
| 15 | | 15 | |
| 16 | -Documentation: [English](docs/en/README.md) · [Français](docs/fr/README.md) · [decisions (ADR)](docs/adr/) · [wireframes](docs/design/README.md) · [releasing](RELEASING.md) | 16 | +Documentation: [English](docs/en/README.md) · [Français](docs/fr/README.md) · [decisions (ADR)](docs/adr/) · [wireframes](docs/design/README.md) · [releasing](RELEASING.md) · [signing for macOS](docs/en/how-to/sign-and-notarize-on-macos.md) |
| 17 | | 17 | |
| 18 | ## Develop | 18 | ## Develop |
| 19 | | 19 | |
| @@ -29,7 +29,7 @@ make release-build # release packages into dist/ (see RELEASING.md) |
| 29 | make help # every target | 29 | make help # every target |
| 30 | ``` | 30 | ``` |
| 31 | | 31 | |
| 32 | -Run it with the four test agents of `agents/` (they need [mm](https://rickub.com/bots-garden/mini-me) and llmman): | 32 | +Run it with the test agents of `agents/` (they need [mm](https://rickub.com/bots-garden/mini-me) and llmman): |
| 33 | | 33 | |
| 34 | ```bash | 34 | ```bash |
| 35 | SIDEKICKS_CONFIG="$PWD/examples/test-agents.yaml" make dev # or: bin/sidekicks --config examples/test-agents.yaml | 35 | SIDEKICKS_CONFIG="$PWD/examples/test-agents.yaml" make dev # or: bin/sidekicks --config examples/test-agents.yaml |
| @@ -46,7 +46,7 @@ Details: [How to develop the application](docs/en/how-to/develop-the-application |
| 46 | | `internal/channels` | Channels and direct conversations: routing (`@agent`, `/agent:command`), unseen context, sessions, streaming, queue, permissions | | 46 | | `internal/channels` | Channels and direct conversations: routing (`@agent`, `/agent:command`), unseen context, sessions, streaming, queue, permissions | |
| 47 | | `internal/store` | The history: channels, members and messages in Pebble, one database per configuration file | | 47 | | `internal/store` | The history: channels, members and messages in Pebble, one database per configuration file | |
| 48 | | `internal/workspace` | An agent's folder, local or in a Docker container: files, changes, terminals | | 48 | | `internal/workspace` | An agent's folder, local or in a Docker container: files, changes, terminals | |
| 49 | -| `internal/lifecycle` | An agent's sbx sandbox: recreated when missing, stopped, removed (`runtime.lifecycle`), and the `sbxenv.yaml` it comes from | | 49 | +| `internal/lifecycle` | An agent's sbx sandbox or Docker container: started or recreated when needed, stopped, removed (`runtime.lifecycle`), and the `sbxenv.yaml` or `compose.yaml` it comes from | |
| 50 | | `internal/prefs` | Last opened and recent configuration files | | 50 | | `internal/prefs` | Last opened and recent configuration files | |
| 51 | | `internal/agents` | The agent processes: lazy start, limit, idle stop, states, logs | | 51 | | `internal/agents` | The agent processes: lazy start, limit, idle stop, states, logs | |
| 52 | | `internal/acp` | ACP v1 client over stdio (wraps `coder/acp-go-sdk`) | | 52 | | `internal/acp` | ACP v1 client over stdio (wraps `coder/acp-go-sdk`) | |
| @@ -56,7 +56,7 @@ Details: [How to develop the application](docs/en/how-to/develop-the-application |
| 56 | | `schema` | JSON Schema of the configuration file | | 56 | | `schema` | JSON Schema of the configuration file | |
| 57 | | `frontend` | Svelte 5 interface: panels, shell, state | | 57 | | `frontend` | Svelte 5 interface: panels, shell, state | |
| 58 | | `scripts` | Test-agent tooling (`agents.sh`), licence header check, release packages (`package.sh`) | | 58 | | `scripts` | Test-agent tooling (`agents.sh`), licence header check, release packages (`package.sh`) | |
| 59 | -| `agents`, `examples` | The four test agents and a configuration using them | | 59 | +| `agents`, `examples` | Test agents (`mario` and `bill` run in a Docker container) and an example configuration | |
| 60 | | `spikes` | Throwaway prototypes of milestone Initialize | | 60 | | `spikes` | Throwaway prototypes of milestone Initialize | |
| 61 | | 61 | |
| 62 | Package diagram: [docs/diagrams/packages.drawio](docs/diagrams/packages.drawio). | 62 | Package diagram: [docs/diagrams/packages.drawio](docs/diagrams/packages.drawio). |