@888aaen/jira-cli-darwin-x64 1.0.1 → 1.3.1

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.
Files changed (3) hide show
  1. package/README.md +184 -0
  2. package/bin/jira +0 -0
  3. package/package.json +5 -1
package/README.md ADDED
@@ -0,0 +1,184 @@
1
+ # jira-cli
2
+
3
+ A non-interactive CLI for Jira designed for AI agents and automation. All output is machine-readable JSON by default, making it ideal for `jq` pipelines and LLM tool calling.
4
+
5
+ ## Credit
6
+
7
+ This project is inspired by [ankitpokhrel/jira-cli](https://github.com/ankitpokhrel/jira-cli) -- a feature-rich **interactive** Jira command line with a full TUI (tables, keyboard navigation, interactive prompts). Think of it as the [k9s](https://k9scli.io/) of Jira: powerful, visual, and built for humans at a terminal.
8
+
9
+ This project takes a different approach. It is the **kubectl** of Jira: non-interactive, scriptable, and designed for AI agents. No TUI, no prompts -- just structured output that machines can parse. If you want a great interactive experience, use [ankitpokhrel/jira-cli](https://github.com/ankitpokhrel/jira-cli). If you want to wire Jira into an AI agent, CI pipeline, or shell script, use this.
10
+
11
+ ## Install
12
+
13
+ ### npm (recommended)
14
+
15
+ ```bash
16
+ npm install -g @888aaen/jira-cli
17
+ ```
18
+
19
+ This installs the `jira` binary for your platform. Works on macOS (arm64, x64), Linux (x64, arm64), and Windows (x64).
20
+
21
+ ### Build from source
22
+
23
+ **Prerequisites:** [Go 1.25+](https://go.dev/dl/)
24
+
25
+ ```bash
26
+ git clone https://github.com/AndersSpringborg/jira-agent-cli.git
27
+ cd jira-agent-cli
28
+ sudo make install
29
+ ```
30
+
31
+ This builds the binary and copies it to `/usr/local/bin/jira`.
32
+
33
+ To uninstall:
34
+
35
+ ```bash
36
+ sudo make uninstall
37
+ ```
38
+
39
+ ## Quick Start (AI Agent)
40
+
41
+ Give your AI agent Jira superpowers in one command:
42
+
43
+ ```bash
44
+ npx skills add 888aaen/jira-cli -g -y
45
+ ```
46
+
47
+ This installs the jira-cli [skill](https://sdk.vercel.ai/docs/ai-sdk-core/agents#primitives-for-agentic-patterns) into your agent's configuration. The skill teaches the agent how to authenticate, search, create, edit, and manage Jira issues -- no manual prompt engineering required.
48
+
49
+ After adding the skill, the agent will:
50
+ 1. Check for an existing Jira auth session
51
+ 2. Guide you through login if needed
52
+ 3. Use the right `jira` command for any Jira-related request
53
+
54
+ ## Quick Start
55
+
56
+ ### 1. Authenticate
57
+
58
+ **Jira Cloud** (*.atlassian.net):
59
+
60
+ 1. Create an API token at https://id.atlassian.com/manage-profile/security/api-tokens
61
+ 2. Run:
62
+
63
+ ```bash
64
+ jira auth login \
65
+ --server https://your-org.atlassian.net \
66
+ --email you@example.com \
67
+ --token YOUR_API_TOKEN
68
+ ```
69
+
70
+ **Jira Server / Data Center** (Personal Access Token):
71
+
72
+ 1. In Jira, go to Profile > Personal Access Tokens
73
+ 2. Run:
74
+
75
+ ```bash
76
+ jira auth login \
77
+ --server https://jira.example.com \
78
+ --token YOUR_PAT
79
+ ```
80
+
81
+ Your token is stored in the OS keychain -- never written to disk.
82
+
83
+ ### 2. Verify connectivity
84
+
85
+ ```bash
86
+ jira ping
87
+ ```
88
+
89
+ ### 3. Set a default project (optional)
90
+
91
+ The context system lets you set defaults so you don't have to repeat flags:
92
+
93
+ ```bash
94
+ jira context set --project PROJ
95
+ jira context set --board-id 42
96
+ ```
97
+
98
+ Now commands like `jira issue list` automatically filter to project `PROJ`.
99
+
100
+ ### 4. Start using it
101
+
102
+ ```bash
103
+ # List issues in your project
104
+ jira issue list
105
+
106
+ # View a specific issue
107
+ jira issue view PROJ-123
108
+
109
+ # Create an issue
110
+ jira issue create -p PROJ -s "Fix login bug" -t Bug
111
+
112
+ # Search with JQL
113
+ jira search jql "project = PROJ AND status = 'In Progress'"
114
+
115
+ # Pipe to jq
116
+ jira issue list | jq '.[].key'
117
+ ```
118
+
119
+ ## Output Formats
120
+
121
+ | Flag | Description |
122
+ |----------------------|------------------------------------------|
123
+ | `--format json` | Machine-readable JSON (default) |
124
+ | `--format markdown` | Structured markdown optimized for LLMs |
125
+
126
+ Set a persistent default with:
127
+
128
+ ```bash
129
+ jira context set --display markdown
130
+ ```
131
+
132
+ The `--format` flag always takes precedence over the context default.
133
+
134
+ ## Commands
135
+
136
+ | Command | Description |
137
+ |-----------------|----------------------------------------------|
138
+ | `jira auth` | Login, logout, status, whoami |
139
+ | `jira config` | Manage profiles (init, list, show, set, use, delete) |
140
+ | `jira context` | Set default filters (project, board, labels, etc.) |
141
+ | `jira issue` | Full issue lifecycle (list, view, create, edit, delete, assign, move, comment, link, clone) |
142
+ | `jira board` | List boards, view board issues |
143
+ | `jira sprint` | List, start, close sprints; add issues |
144
+ | `jira project` | List and view projects |
145
+ | `jira search` | JQL and full-text search |
146
+ | `jira user` | Search and get users |
147
+ | `jira me` | Show current user |
148
+ | `jira open` | Open project or issue in browser |
149
+ | `jira ping` | Check connectivity to Jira |
150
+
151
+ Run `jira <command> --help` for details on any command.
152
+
153
+ ## Configuration
154
+
155
+ Config lives at `~/.config/jira-cli/config.yml`. You normally don't need to edit it by hand -- use the `jira config` and `jira context` commands instead.
156
+
157
+ ### Profiles
158
+
159
+ Profiles let you manage multiple Jira instances:
160
+
161
+ ```bash
162
+ # Create a profile for a second instance
163
+ jira config init --profile work --base-url https://work.atlassian.net
164
+ jira auth login --profile work --server https://work.atlassian.net \
165
+ --email you@work.com --token YOUR_TOKEN
166
+
167
+ # Switch default profile
168
+ jira config use work
169
+
170
+ # Use a profile for a single command
171
+ jira issue list --profile work
172
+ ```
173
+
174
+ ### Environment Variables
175
+
176
+ These override config file values and are useful in CI/automation:
177
+
178
+ | Variable | Description |
179
+ |-------------------|-------------------------------------|
180
+ | `JIRA_BASE_URL` | Jira server URL |
181
+ | `JIRA_TOKEN` | API token (bypasses OS keychain) |
182
+ | `JIRA_EMAIL` | User email |
183
+ | `JIRA_AUTH_TYPE` | Auth type: `basic` or `pat` |
184
+ | `JIRABOT_PROFILE` | Profile name to use |
package/bin/jira CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@888aaen/jira-cli-darwin-x64",
3
- "version": "1.0.1",
3
+ "version": "1.3.1",
4
4
  "description": "jira-cli binary for macOS x64 (Intel)",
5
5
  "os": [
6
6
  "darwin"
@@ -15,5 +15,9 @@
15
15
  ],
16
16
  "bin": {
17
17
  "jira": "bin/jira"
18
+ },
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "git+https://github.com/AndersSpringborg/jira-agent-cli.git"
18
22
  }
19
23
  }