@pleaseai/work 0.1.7 → 0.1.8
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 +74 -10
- package/dist/index.js +27936 -27082
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Work Please
|
|
2
2
|
|
|
3
|
+
English | [한국어](README.ko.md) | [日本語](README.ja.md) | [简体中文](README.zh-CN.md)
|
|
4
|
+
|
|
3
5
|
[](https://sonarcloud.io/summary/new_code?id=pleaseai_work-please) [](https://sonarcloud.io/summary/new_code?id=pleaseai_work-please) [](https://sonarcloud.io/summary/new_code?id=pleaseai_work-please) [](https://sonarcloud.io/summary/new_code?id=pleaseai_work-please)
|
|
4
6
|
[](https://codecov.io/gh/pleaseai/work-please)
|
|
5
7
|
|
|
@@ -124,7 +126,7 @@ See [SPEC.md](SPEC.md) for the full specification.
|
|
|
124
126
|
### Install
|
|
125
127
|
|
|
126
128
|
```bash
|
|
127
|
-
git clone https://github.com/
|
|
129
|
+
git clone https://github.com/pleaseai/work-please.git
|
|
128
130
|
cd work-please
|
|
129
131
|
bun install
|
|
130
132
|
bun run build
|
|
@@ -147,10 +149,22 @@ tracker:
|
|
|
147
149
|
owner: your-org
|
|
148
150
|
project_number: 42
|
|
149
151
|
active_statuses:
|
|
152
|
+
- Todo
|
|
150
153
|
- In Progress
|
|
154
|
+
- Merging
|
|
155
|
+
- Rework
|
|
151
156
|
terminal_statuses:
|
|
152
|
-
-
|
|
157
|
+
- Closed
|
|
153
158
|
- Cancelled
|
|
159
|
+
- Canceled
|
|
160
|
+
- Duplicate
|
|
161
|
+
- Done
|
|
162
|
+
watched_statuses:
|
|
163
|
+
- Human Review
|
|
164
|
+
auto_transitions:
|
|
165
|
+
human_review_to_rework: true
|
|
166
|
+
human_review_to_merging: true
|
|
167
|
+
include_bot_reviews: true
|
|
154
168
|
|
|
155
169
|
polling:
|
|
156
170
|
interval_ms: 30000
|
|
@@ -194,7 +208,7 @@ Your task:
|
|
|
194
208
|
1. Understand the issue requirements.
|
|
195
209
|
2. Implement the requested changes.
|
|
196
210
|
3. Write or update tests as needed.
|
|
197
|
-
4. Open a pull request and move this issue to
|
|
211
|
+
4. Open a pull request and move this issue to `Human Review`.
|
|
198
212
|
```
|
|
199
213
|
|
|
200
214
|
#### GitHub Projects v2 (GitHub App)
|
|
@@ -211,10 +225,22 @@ tracker:
|
|
|
211
225
|
owner: your-org
|
|
212
226
|
project_number: 42
|
|
213
227
|
active_statuses:
|
|
228
|
+
- Todo
|
|
214
229
|
- In Progress
|
|
230
|
+
- Merging
|
|
231
|
+
- Rework
|
|
215
232
|
terminal_statuses:
|
|
216
|
-
-
|
|
233
|
+
- Closed
|
|
217
234
|
- Cancelled
|
|
235
|
+
- Canceled
|
|
236
|
+
- Duplicate
|
|
237
|
+
- Done
|
|
238
|
+
watched_statuses:
|
|
239
|
+
- Human Review
|
|
240
|
+
auto_transitions:
|
|
241
|
+
human_review_to_rework: true
|
|
242
|
+
human_review_to_merging: true
|
|
243
|
+
include_bot_reviews: true
|
|
218
244
|
|
|
219
245
|
polling:
|
|
220
246
|
interval_ms: 30000
|
|
@@ -258,7 +284,7 @@ Your task:
|
|
|
258
284
|
1. Understand the issue requirements.
|
|
259
285
|
2. Implement the requested changes.
|
|
260
286
|
3. Write or update tests as needed.
|
|
261
|
-
4. Open a pull request and move this issue to
|
|
287
|
+
4. Open a pull request and move this issue to `Human Review`.
|
|
262
288
|
```
|
|
263
289
|
|
|
264
290
|
#### Asana (under development)
|
|
@@ -319,7 +345,7 @@ Your task:
|
|
|
319
345
|
1. Understand the task requirements.
|
|
320
346
|
2. Implement the requested changes.
|
|
321
347
|
3. Write or update tests as needed.
|
|
322
|
-
4. Open a pull request and move this task to the review section.
|
|
348
|
+
4. Open a pull request and move this task to the review section (e.g. `Human Review`).
|
|
323
349
|
```
|
|
324
350
|
|
|
325
351
|
### Run
|
|
@@ -362,11 +388,23 @@ tracker:
|
|
|
362
388
|
owner: your-org # Required: GitHub organization or user login
|
|
363
389
|
project_number: 42 # Required: GitHub Projects v2 project number
|
|
364
390
|
project_id: PVT_kwDOxxxxx # Optional: project node ID (bypasses owner+project_number lookup)
|
|
365
|
-
active_statuses: # Optional: default ["Todo", "In Progress"]
|
|
391
|
+
active_statuses: # Optional: default ["Todo", "In Progress", "Merging", "Rework"]
|
|
392
|
+
- Todo
|
|
366
393
|
- In Progress
|
|
367
|
-
|
|
368
|
-
-
|
|
394
|
+
- Merging
|
|
395
|
+
- Rework
|
|
396
|
+
terminal_statuses: # Optional: default ["Closed", "Cancelled", "Canceled", "Duplicate", "Done"]
|
|
397
|
+
- Closed
|
|
369
398
|
- Cancelled
|
|
399
|
+
- Canceled
|
|
400
|
+
- Duplicate
|
|
401
|
+
- Done
|
|
402
|
+
watched_statuses: # Optional: states polled but not dispatched. Default ["Human Review"]
|
|
403
|
+
- Human Review
|
|
404
|
+
auto_transitions: # Optional: auto-transition rules for watched states
|
|
405
|
+
human_review_to_rework: true # Move to Rework on CHANGES_REQUESTED or unresolved threads. Default true
|
|
406
|
+
human_review_to_merging: true # Move to Merging on APPROVED + no unresolved threads. Default true
|
|
407
|
+
include_bot_reviews: true # Whether bot comment threads count as unresolved. Default true
|
|
370
408
|
# GitHub App authentication (alternative to api_key — all three required together):
|
|
371
409
|
# app_id: $GITHUB_APP_ID # Optional: GitHub App ID (integer or $ENV_VAR)
|
|
372
410
|
# private_key: $GITHUB_APP_PRIVATE_KEY # Optional: GitHub App private key PEM or $ENV_VAR
|
|
@@ -408,12 +446,14 @@ hooks:
|
|
|
408
446
|
|
|
409
447
|
agent:
|
|
410
448
|
max_concurrent_agents: 10 # Optional: global concurrency limit, default 10
|
|
449
|
+
max_turns: 20 # Optional: max turns per agent run, default 20
|
|
411
450
|
max_retry_backoff_ms: 300000 # Optional: max retry delay in ms, default 300000
|
|
412
451
|
max_concurrent_agents_by_state: # Optional: per-state concurrency limits
|
|
413
452
|
in progress: 5
|
|
414
453
|
|
|
415
454
|
claude:
|
|
416
455
|
command: claude # Optional: Claude Code CLI command, default "claude"
|
|
456
|
+
model: claude-sonnet-4-5-20250514 # Optional: override Claude model. Default: CLI default
|
|
417
457
|
effort: high # Optional: reasoning depth — 'low', 'medium', 'high', or 'max'. Default 'high'.
|
|
418
458
|
permission_mode: acceptEdits # Optional: one of 'default', 'acceptEdits', 'bypassPermissions'. Defaults to 'bypassPermissions'.
|
|
419
459
|
allowed_tools: # Optional: restrict available tools
|
|
@@ -428,13 +468,26 @@ claude:
|
|
|
428
468
|
turn_timeout_ms: 3600000 # Optional: per-turn timeout in ms, default 3600000
|
|
429
469
|
read_timeout_ms: 5000 # Optional: initial subprocess read timeout in ms, default 5000
|
|
430
470
|
stall_timeout_ms: 300000 # Optional: stall detection timeout, default 300000
|
|
471
|
+
system_prompt: "custom prompt" # Optional: custom system prompt string. Default: built-in claude_code preset
|
|
431
472
|
settings:
|
|
432
473
|
attribution:
|
|
433
474
|
commit: "🙏 Generated with [Work Please](https://github.com/pleaseai/work-please)" # Optional: appended to git commit messages. Defaults to Work Please link.
|
|
434
475
|
pr: "🙏 Generated with [Work Please](https://github.com/pleaseai/work-please)" # Optional: appended to PR descriptions. Defaults to Work Please link.
|
|
435
476
|
|
|
477
|
+
# worker: # Optional: SSH worker support (experimental)
|
|
478
|
+
# ssh_hosts: # List of SSH host aliases for remote execution
|
|
479
|
+
# - worker-1
|
|
480
|
+
# - worker-2
|
|
481
|
+
# max_concurrent_agents_per_host: 5 # Max agents per SSH host
|
|
482
|
+
|
|
483
|
+
# observability: # Optional: TUI dashboard settings
|
|
484
|
+
# dashboard_enabled: true # Enable TUI dashboard, default true
|
|
485
|
+
# refresh_ms: 1000 # Dashboard data refresh interval, default 1000
|
|
486
|
+
# render_interval_ms: 16 # TUI render interval, default 16
|
|
487
|
+
|
|
436
488
|
server:
|
|
437
489
|
port: 3000 # Optional: enable HTTP dashboard on this port
|
|
490
|
+
host: "127.0.0.1" # Optional: bind address, default "127.0.0.1"
|
|
438
491
|
---
|
|
439
492
|
|
|
440
493
|
Your prompt template goes here. Available variables:
|
|
@@ -448,10 +501,21 @@ Your prompt template goes here. Available variables:
|
|
|
448
501
|
- {{ issue.assignees }} — Array of assignee logins (GitHub) or emails (Asana)
|
|
449
502
|
- {{ issue.labels }} — Array of label strings (normalized to lowercase)
|
|
450
503
|
- {{ issue.blocked_by }} — Array of blocker refs (each has id, identifier, state)
|
|
504
|
+
- {{ issue.branch_name }} — PR head branch name (for PullRequest items) or null
|
|
451
505
|
- {{ issue.pull_requests }} — Array of linked PRs (each has number, title, url, state, branch_name)
|
|
506
|
+
- {{ issue.review_decision }} — PR review decision: "approved", "changes_requested", "commented", "review_required", or null
|
|
507
|
+
- {{ issue.has_unresolved_threads }} — Whether the PR has unresolved review threads
|
|
508
|
+
- {{ issue.has_unresolved_human_threads }} — Whether the PR has unresolved non-bot review threads
|
|
452
509
|
- {{ issue.priority }} — Numeric priority or null
|
|
453
510
|
- {{ issue.created_at }} — ISO-8601 creation timestamp
|
|
454
511
|
- {{ issue.updated_at }} — ISO-8601 last-updated timestamp
|
|
512
|
+
- {{ issue.project }} — GitHub Projects v2 context (null for Asana):
|
|
513
|
+
- {{ issue.project.owner }} — Project owner login
|
|
514
|
+
- {{ issue.project.number }} — Project number
|
|
515
|
+
- {{ issue.project.project_id }} — Project GraphQL node ID (resolved at runtime)
|
|
516
|
+
- {{ issue.project.item_id }} — Project item GraphQL node ID
|
|
517
|
+
- {{ issue.project.field_id }} — Status field GraphQL node ID (resolved at runtime)
|
|
518
|
+
- {{ issue.project.status_options }} — Array of { name, id } for status field options
|
|
455
519
|
- {{ attempt }} — Retry attempt number (null on first run)
|
|
456
520
|
```
|
|
457
521
|
|
|
@@ -601,7 +665,7 @@ Start with `default` or `acceptEdits` unless you are running in a fully isolated
|
|
|
601
665
|
|
|
602
666
|
## License
|
|
603
667
|
|
|
604
|
-
|
|
668
|
+
Functional Source License 1.1, MIT Future License (FSL-1.1-MIT). See [LICENSE](LICENSE) for details.
|
|
605
669
|
|
|
606
670
|
Work Please is a TypeScript implementation based on the
|
|
607
671
|
[Symphony specification](vendor/symphony/SPEC.md) by OpenAI (Apache 2.0).
|