claude-teammate 0.1.21 → 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 +36 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -91,14 +91,20 @@ memory/
|
|
|
91
91
|
|
|
92
92
|
## Quickstart
|
|
93
93
|
|
|
94
|
-
**Requirements:**
|
|
94
|
+
**Requirements:**
|
|
95
|
+
- Node.js 20+
|
|
96
|
+
- [Claude CLI](https://docs.anthropic.com/en/docs/claude-code) installed and authenticated
|
|
97
|
+
- A Jira API token
|
|
98
|
+
- A GitHub PAT with `repo` + PR permissions
|
|
95
99
|
|
|
96
100
|
```bash
|
|
97
101
|
npm install -g claude-teammate
|
|
98
102
|
tm8 start
|
|
99
103
|
```
|
|
100
104
|
|
|
101
|
-
`start` creates
|
|
105
|
+
`start` creates `~/.tm8/.env` on the first run. If that config already exists with the required values, setup is skipped and your credentials are not prompted for again.
|
|
106
|
+
|
|
107
|
+
To run multiple agents on the same machine, use `--local` to store agent status and memory in the current working folder.
|
|
102
108
|
|
|
103
109
|
To upgrade to latest version
|
|
104
110
|
|
|
@@ -113,32 +119,31 @@ tm8 status
|
|
|
113
119
|
tm8 stop
|
|
114
120
|
```
|
|
115
121
|
|
|
116
|
-
|
|
122
|
+
Global runtime files and memory are stored in:
|
|
117
123
|
|
|
118
124
|
```text
|
|
119
|
-
|
|
120
|
-
├──
|
|
121
|
-
├──
|
|
122
|
-
├──
|
|
123
|
-
|
|
125
|
+
~/.tm8/
|
|
126
|
+
├── .env
|
|
127
|
+
├── .claude-teammate/
|
|
128
|
+
├── repos/
|
|
129
|
+
├── worker.log
|
|
130
|
+
├── worker.pid
|
|
131
|
+
└── state.json
|
|
132
|
+
└── memory/
|
|
133
|
+
└── {domain}/
|
|
134
|
+
└── {workspace}/
|
|
135
|
+
├── epic-{jira-key}.md
|
|
136
|
+
└── issue-{jira-key}.md
|
|
124
137
|
```
|
|
125
138
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
```text
|
|
129
|
-
memory/
|
|
130
|
-
└── {domain}/
|
|
131
|
-
└── {workspace}/
|
|
132
|
-
├── epic-{jira-key}.md
|
|
133
|
-
└── issue-{jira-key}.md
|
|
134
|
-
```
|
|
139
|
+
With `--local`, the same `.claude-teammate/` and `memory/` folders are created in the current working directory instead.
|
|
135
140
|
|
|
136
141
|
`epic-{jira-key}.md` stores shared epic facts such as canonical epic identity, related repositories, reusable summaries, and guardrails. `issue-{jira-key}.md` stores issue-specific workflow state, clarification history, and GitHub issue tracking.
|
|
137
142
|
|
|
138
143
|
The worker polls Jira once per minute. It transitions `To Do` issues to `In Progress`, asks for repo URLs when epic memory lacks them, clones all referenced repos into `.claude-teammate/repos/`, uses Claude CLI to clarify requirements from Jira comments across those repos, and creates GitHub issues once the requirements are clear enough.
|
|
139
144
|
|
|
140
145
|
```env
|
|
141
|
-
# .env file generated by `tm8 start`
|
|
146
|
+
# .env file generated by `tm8 start` or `tm8 start --local`
|
|
142
147
|
JIRA_BASE_URL=https://yourorg.atlassian.net
|
|
143
148
|
JIRA_BOT_EMAIL=bot@yourorg.com
|
|
144
149
|
JIRA_BOT_API_TOKEN=...
|
|
@@ -163,6 +168,19 @@ It reads the actual repository before writing anything - structure, conventions,
|
|
|
163
168
|
|
|
164
169
|
<br/>
|
|
165
170
|
|
|
171
|
+
## Roadmap
|
|
172
|
+
|
|
173
|
+
- GitLab support
|
|
174
|
+
- Bitbucket support
|
|
175
|
+
- Ensure no conflicts for multiple concurrent claude-teammate agents
|
|
176
|
+
- Slack and Teams notifications when PRs are opened or merged
|
|
177
|
+
- Automatic PR description generation from commit history and issue context
|
|
178
|
+
- Branch-naming convention enforcement per epic or project config
|
|
179
|
+
- Stale-issue nudges when tickets sit unactioned past a configurable threshold
|
|
180
|
+
- Test-coverage gating before issue closure
|
|
181
|
+
|
|
182
|
+
<br/>
|
|
183
|
+
|
|
166
184
|
## Contributing
|
|
167
185
|
|
|
168
186
|
Contributions are welcome. Open an issue to discuss before submitting large changes.
|