jira-jr 0.5.2 → 0.5.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 +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# jira-jr
|
|
2
|
+
|
|
3
|
+
**Jira CLI built for AI agents** — pure JSON output, semantic exit codes, 600+ auto-generated commands, and built-in jq filtering.
|
|
4
|
+
|
|
5
|
+
Give your AI agent (Claude Code, Cursor, Copilot, or custom bots) reliable, token-efficient access to Jira Cloud.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g jira-jr
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Why jr?
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Full Jira response: ~10,000 tokens
|
|
17
|
+
jr issue get --issueIdOrKey PROJ-123
|
|
18
|
+
|
|
19
|
+
# With jr's filtering: ~50 tokens
|
|
20
|
+
jr issue get --issueIdOrKey PROJ-123 --fields key,summary --jq '{key: .key, summary: .fields.summary}'
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
- **All output is JSON** — stdout for data, stderr for errors, always
|
|
24
|
+
- **Semantic exit codes** — 0=ok, 2=auth, 3=not_found, 5=rate_limited — agents can branch without parsing
|
|
25
|
+
- **600+ commands** from the official Jira OpenAPI spec, synced weekly
|
|
26
|
+
- **Batch operations** — N API calls in one process via `jr batch`
|
|
27
|
+
- **Self-describing** — `jr schema --compact` lets agents discover commands at runtime
|
|
28
|
+
- **Workflow helpers** — `jr workflow transition --to "Done"` resolves IDs automatically
|
|
29
|
+
|
|
30
|
+
## Quick start
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# Configure
|
|
34
|
+
jr configure --base-url https://yoursite.atlassian.net --token YOUR_API_TOKEN
|
|
35
|
+
|
|
36
|
+
# Search issues
|
|
37
|
+
jr search search-and-reconsile-issues-using-jql \
|
|
38
|
+
--jql "project = PROJ AND status = 'In Progress'" \
|
|
39
|
+
--jq '[.issues[] | {key, summary: .fields.summary}]'
|
|
40
|
+
|
|
41
|
+
# Transition + assign in one call
|
|
42
|
+
echo '[
|
|
43
|
+
{"command":"workflow transition","args":{"issue":"PROJ-123","to":"Done"}},
|
|
44
|
+
{"command":"workflow assign","args":{"issue":"PROJ-123","to":"me"}}
|
|
45
|
+
]' | jr batch
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Also available via
|
|
49
|
+
|
|
50
|
+
- **Homebrew**: `brew install sofq/tap/jr`
|
|
51
|
+
- **Scoop**: `scoop bucket add sofq https://github.com/sofq/scoop-bucket && scoop install jr`
|
|
52
|
+
- **Docker**: `docker run --rm ghcr.io/sofq/jr version`
|
|
53
|
+
- **Go**: `go install github.com/sofq/jira-cli@latest`
|
|
54
|
+
|
|
55
|
+
## Documentation
|
|
56
|
+
|
|
57
|
+
Full docs, Claude Code skill, and source at [github.com/sofq/jira-cli](https://github.com/sofq/jira-cli).
|