openthrottle 0.1.0 → 0.1.2
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 +41 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/knoxgraeme/openthrottle/main/assets/banner.jpg" alt="Open Throttle" width="100%" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
CLI for [Open Throttle](https://github.com/knoxgraeme/openthrottle) — ship prompts to autonomous coding agents running on Daytona sandboxes.
|
|
6
|
+
|
|
7
|
+
## Quick start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx openthrottle init # one-time project setup
|
|
11
|
+
npx openthrottle ship docs/prds/auth.md # ship a prompt
|
|
12
|
+
npx openthrottle status # check running/queued tasks
|
|
13
|
+
npx openthrottle logs # view workflow runs
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Prerequisites
|
|
17
|
+
|
|
18
|
+
- [gh CLI](https://cli.github.com) installed and authenticated (`gh auth login`)
|
|
19
|
+
- A git repo with a GitHub remote
|
|
20
|
+
- `.openthrottle.yml` in the repo root (generated by `openthrottle init`)
|
|
21
|
+
|
|
22
|
+
## Commands
|
|
23
|
+
|
|
24
|
+
| Command | What it does |
|
|
25
|
+
|---|---|
|
|
26
|
+
| `init` | Detect your project, generate config, create Daytona snapshot |
|
|
27
|
+
| `ship <file.md> [--base branch]` | Create a GitHub issue to trigger a sandbox |
|
|
28
|
+
| `status` | Show running, queued, reviewing, and completed tasks |
|
|
29
|
+
| `logs` | Show recent GitHub Actions workflow runs |
|
|
30
|
+
|
|
31
|
+
## How it works
|
|
32
|
+
|
|
33
|
+
1. `openthrottle init` generates `.openthrottle.yml` and a GitHub Actions workflow
|
|
34
|
+
2. `openthrottle ship` creates a GitHub issue with the `prd-queued` label
|
|
35
|
+
3. The workflow creates an ephemeral Daytona sandbox
|
|
36
|
+
4. An agent (Claude, Codex, or Aider) implements the work and opens a PR
|
|
37
|
+
5. Sandbox auto-deletes when done
|
|
38
|
+
|
|
39
|
+
## License
|
|
40
|
+
|
|
41
|
+
MIT
|