@atolis-hq/wake 0.1.22 → 0.1.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +107 -2
- package/dist/src/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,48 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
<img src="https://raw.githubusercontent.com/atolis-hq/wake/refs/heads/main/assets/wake-logo.svg" alt="logo" width="200" height="auto" />
|
|
5
|
+
<h1>Wake</h1>
|
|
6
|
+
|
|
7
|
+
<p>
|
|
8
|
+
Autonomous software engineering control plane
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<!-- Badges -->
|
|
13
|
+
<p>
|
|
14
|
+
<a href="https://github.com/atolis-hq/wake/commits/main">
|
|
15
|
+
<img src="https://img.shields.io/github/last-commit/atolis-hq/wake" alt="last update" />
|
|
16
|
+
</a>
|
|
17
|
+
<a href="https://github.com/atolis-hq/wake/actions/workflows/ci-cd.yml">
|
|
18
|
+
<img src="https://github.com/atolis-hq/wake/actions/workflows/ci-cd.yml/badge.svg" alt="CI/CD status" />
|
|
19
|
+
</a>
|
|
20
|
+
<!-- <a href="https://github.com/atolis-hq/wake/network/members">
|
|
21
|
+
<img src="https://img.shields.io/github/forks/atolis-hq/wake" alt="forks" />
|
|
22
|
+
</a>
|
|
23
|
+
<a href="https://github.com/atolis-hq/wake/stargazers">
|
|
24
|
+
<img src="https://img.shields.io/github/stars/atolis-hq/wake" alt="stars" />
|
|
25
|
+
</a> -->
|
|
26
|
+
<a href="https://github.com/atolis-hq/wake/issues/">
|
|
27
|
+
<img src="https://img.shields.io/github/issues/atolis-hq/wake" alt="open issues" />
|
|
28
|
+
</a>
|
|
29
|
+
<a href="https://github.com/atolis-hq/wake/blob/main/LICENSE">
|
|
30
|
+
<img src="https://img.shields.io/github/license/atolis-hq/wake.svg" alt="license" />
|
|
31
|
+
</a>
|
|
32
|
+
<a href="https://github.com/atolis-hq/wake/tags">
|
|
33
|
+
<img src="https://img.shields.io/github/v/tag/atolis-hq/wake" alt="latest tag" />
|
|
34
|
+
</a>
|
|
35
|
+
<a href="https://www.npmjs.com/package/@atolis-hq/wake">
|
|
36
|
+
<img src="https://img.shields.io/npm/v/%40atolis-hq%2Fwake" alt="npm version" />
|
|
37
|
+
</a>
|
|
38
|
+
<a href="docker/Dockerfile">
|
|
39
|
+
<img src="https://img.shields.io/badge/sandbox-docker-2496ED?logo=docker&logoColor=white" alt="runs in docker" />
|
|
40
|
+
</a>
|
|
41
|
+
</p>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<br />
|
|
45
|
+
|
|
2
46
|
|
|
3
47
|
Wake is a control plane for autonomous software engineering. It watches the
|
|
4
48
|
channels your team already uses, coordinates agent activity and involves humans
|
|
@@ -10,7 +54,20 @@ asks for input when human judgment matters, proposes a plan, launches local
|
|
|
10
54
|
coding-agent CLIs to implement changes, opens pull requests, and carries the
|
|
11
55
|
conversation forward wherever the work is already happening.
|
|
12
56
|
|
|
13
|
-
|
|
57
|
+
|
|
58
|
+
## Table of Contents
|
|
59
|
+
|
|
60
|
+
- [The Problem](#the-problem)
|
|
61
|
+
- [Vision](#vision)
|
|
62
|
+
- [Feature Overview](#feature-overview)
|
|
63
|
+
- [Where the Work Happens](#where-the-work-happens)
|
|
64
|
+
- [Supported Agent CLIs](#supported-agent-clis)
|
|
65
|
+
- [Getting Started](#getting-started)
|
|
66
|
+
- [Development](#development)
|
|
67
|
+
- [Documentation](#documentation)
|
|
68
|
+
- [Issues & Feature Requests](#issues--feature-requests)
|
|
69
|
+
- [License](#license)
|
|
70
|
+
|
|
14
71
|
|
|
15
72
|
## The Problem
|
|
16
73
|
|
|
@@ -75,6 +132,34 @@ For more detail, see [docs/vision.md](docs/vision.md) and
|
|
|
75
132
|
Current runner capability differences are documented in
|
|
76
133
|
[docs/runner-comparison.md](docs/runner-comparison.md).
|
|
77
134
|
|
|
135
|
+
## Where the Work Happens
|
|
136
|
+
|
|
137
|
+
Wake has no chat UI you need to check for status. Your ticketing system is the
|
|
138
|
+
interface: Wake posts progress updates, asks clarifying questions, and reports
|
|
139
|
+
results as comments on the ticket, and reflects stage and status as labels on
|
|
140
|
+
it. When it's ready, it opens a pull request against your repo the normal way.
|
|
141
|
+
Reviewing, approving, and merging happen exactly where they already do today —
|
|
142
|
+
nothing new to learn, no separate dashboard to babysit.
|
|
143
|
+
|
|
144
|
+
A local control-plane UI exists for operators who want to watch runs, inspect
|
|
145
|
+
events, or resume a session directly, but it's a window into the same state —
|
|
146
|
+
not a required part of the workflow.
|
|
147
|
+
|
|
148
|
+
## Supported Agent CLIs
|
|
149
|
+
|
|
150
|
+
Wake wraps existing coding-agent CLIs rather than replacing them. Runner
|
|
151
|
+
adapters currently exist for:
|
|
152
|
+
|
|
153
|
+
- **[Claude Code](https://claude.com/claude-code)**
|
|
154
|
+
- **[Codex](https://openai.com/codex/)**
|
|
155
|
+
- **[Cursor](https://cursor.com/cli)**
|
|
156
|
+
|
|
157
|
+
Each runner sits behind the same `AgentRunner` contract, so Wake's routing,
|
|
158
|
+
lifecycle, and sandbox behavior stay the same regardless of which CLI executes
|
|
159
|
+
a given step. A fake runner adapter also exists for zero-token testing of the
|
|
160
|
+
control plane itself. See [docs/runner-comparison.md](docs/runner-comparison.md)
|
|
161
|
+
for capability differences between runners.
|
|
162
|
+
|
|
78
163
|
## Getting Started
|
|
79
164
|
|
|
80
165
|
Wake is distributed as the `@atolis-hq/wake` npm package. You can run the CLI
|
|
@@ -143,3 +228,23 @@ Recommended local practices:
|
|
|
143
228
|
|
|
144
229
|
Local setup, commands, sandbox operation, auth setup, UI notes, and GitHub
|
|
145
230
|
polling details are documented in [docs/development.md](docs/development.md).
|
|
231
|
+
|
|
232
|
+
## Documentation
|
|
233
|
+
|
|
234
|
+
- [docs/vision.md](docs/vision.md) — the rationale and long-term direction for Wake.
|
|
235
|
+
- [docs/architecture.md](docs/architecture.md) — module boundaries and the event-sourced core.
|
|
236
|
+
- [docs/implementation.md](docs/implementation.md) — the accepted implementation plan.
|
|
237
|
+
- [docs/workflows.md](docs/workflows.md) — how stages, prompts, and runner routes are configured.
|
|
238
|
+
- [docs/prompts.md](docs/prompts.md) — how prompt templates map to workflow stages.
|
|
239
|
+
- [docs/configuration.md](docs/configuration.md) — `config.json` options and the operator correlation escape hatch.
|
|
240
|
+
- [docs/development.md](docs/development.md) — local setup and sandbox development workflow.
|
|
241
|
+
- [docs/runner-comparison.md](docs/runner-comparison.md) — capability differences between supported runners.
|
|
242
|
+
|
|
243
|
+
## Issues & Feature Requests
|
|
244
|
+
|
|
245
|
+
Found a bug or have an idea for Wake? [Open an issue](https://github.com/atolis-hq/wake/issues/new) —
|
|
246
|
+
bug reports and feature requests are both welcome.
|
|
247
|
+
|
|
248
|
+
## License
|
|
249
|
+
|
|
250
|
+
Wake is licensed under the [Apache License 2.0](LICENSE).
|
package/dist/src/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const wakeVersion = "0.1.
|
|
1
|
+
export const wakeVersion = "0.1.23+ge21a0d4";
|