@elmiristic/agent-ready 0.1.3 → 0.1.4
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 +39 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,39 +2,62 @@
|
|
|
2
2
|
|
|
3
3
|
Wire an AI coding agent into any GitHub repo in 5 minutes.
|
|
4
4
|
|
|
5
|
-
Tag a Trello card **agent-ready
|
|
5
|
+
Tag a Trello card **agent-ready** and Claude reads the task, writes the code, opens a PR, and pings you on Telegram. Runs on your schedule, in your timezone.
|
|
6
6
|
|
|
7
7
|
## Quick start
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npx agent-ready init
|
|
10
|
+
npx @elmiristic/agent-ready init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
The wizard
|
|
14
|
-
1. Connect your Trello board
|
|
15
|
-
2. Add your Anthropic API key
|
|
16
|
-
3. Give you a Telegram chat ID via @agent_ready_bot
|
|
17
|
-
4. Set all GitHub secrets automatically
|
|
18
|
-
5. Write the GitHub Actions workflows into your repo
|
|
13
|
+
That's it. The wizard handles everything.
|
|
19
14
|
|
|
20
|
-
|
|
15
|
+
## What the wizard sets up
|
|
16
|
+
|
|
17
|
+
1. **Board** - connect your Trello board and pick the right lists
|
|
18
|
+
2. **Anthropic** - add your Claude API key
|
|
19
|
+
3. **Telegram** - message [@agentreadybot](https://t.me/agentreadybot) and paste your chat ID. No bot setup needed.
|
|
20
|
+
4. **Schedule** - pick your timezone and the times you want the agent to run each day
|
|
21
|
+
5. **GitHub secrets** - set automatically via GitHub CLI, or manually if you prefer
|
|
22
|
+
6. **Workflow files** - written directly into your repo under `.github/`
|
|
23
|
+
|
|
24
|
+
Then run:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
git add .github && git commit -m "feat: add agent-ready" && git push
|
|
28
|
+
```
|
|
21
29
|
|
|
22
30
|
## How it works
|
|
23
31
|
|
|
24
|
-
1. Add the `agent-ready` label to a Trello card in your
|
|
25
|
-
2. The agent runs at
|
|
26
|
-
3. Claude reads the card title
|
|
27
|
-
4. A PR is opened
|
|
32
|
+
1. Add the `agent-ready` label to a Trello card in your To Do list
|
|
33
|
+
2. The agent runs at the times you chose during setup
|
|
34
|
+
3. Claude reads the card title and description, finds the relevant files, and writes the code
|
|
35
|
+
4. A PR is opened with a summary of the change
|
|
28
36
|
5. You get a Telegram message with the PR link
|
|
29
|
-
6. Merge the PR
|
|
37
|
+
6. Merge the PR and the card moves to Done automatically
|
|
38
|
+
|
|
39
|
+
Nothing touches `main` without your review.
|
|
40
|
+
|
|
41
|
+
## Schedule
|
|
42
|
+
|
|
43
|
+
During setup you pick your timezone and up to two daily run times. The wizard converts them to UTC and writes the correct cron expressions into your workflow file. You can also trigger a run manually anytime from the GitHub Actions tab.
|
|
30
44
|
|
|
31
45
|
## Requirements
|
|
32
46
|
|
|
33
47
|
- Node.js 18+
|
|
34
48
|
- A GitHub repository
|
|
35
|
-
- GitHub CLI (`gh`) for automatic secret setup (optional - can set manually)
|
|
36
49
|
- A Trello account
|
|
37
|
-
- An Anthropic API key
|
|
50
|
+
- An Anthropic API key (get one at [console.anthropic.com](https://console.anthropic.com))
|
|
51
|
+
- GitHub CLI (`gh`) for automatic secret setup — optional, secrets can be added manually
|
|
52
|
+
|
|
53
|
+
## Supported board tools
|
|
54
|
+
|
|
55
|
+
| Tool | Status |
|
|
56
|
+
|------|--------|
|
|
57
|
+
| Trello | Available |
|
|
58
|
+
| Jira | Coming soon |
|
|
59
|
+
| Linear | Coming soon |
|
|
60
|
+
| GitHub Projects | Coming soon |
|
|
38
61
|
|
|
39
62
|
## License
|
|
40
63
|
|