jira-ai

Category: Testing & Security | Uploader: festoinc | Downloads: 0 | Version: v1.0（Latest）

An AI-friendly CLI for Jira designed for maximum efficiency and security. All output is structured JSON — no human-readable formatting, no interactive prompts.

Changelog: Source: GitHub https://github.com/festoinc/jira-ai

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 workflows/
  - 📄 publish.yml 664 B
📁 src/
- 📁 commands/
  - 📄 about.ts 201 B
  - 📄 add-comment.ts 2.2 KB
  - 📄 add-label.ts 1.3 KB
  - 📄 attach.ts 4.5 KB
  - 📄 auth.ts 4.4 KB
  - 📄 backlog.ts 813 B
  - 📄 board.ts 2.9 KB
  - 📄 confluence.ts 9.2 KB
  - 📄 create-issue-link.ts 1.3 KB
  - 📄 create-task.ts 4.3 KB
  - 📄 delete-issue-link.ts 2.0 KB
  - 📄 delete-label.ts 1.3 KB
  - 📄 epic.ts 8.0 KB
  - 📄 get-issue-statistics.ts 980 B
  - 📄 get-person-worklog.ts 1.9 KB
  - 📄 issue.ts 1.1 KB
  - 📄 list-colleagues.ts 763 B
  - 📄 list-issue-links.ts 1008 B
  - 📄 list-issue-types.ts 788 B
  - 📄 list-link-types.ts 688 B
  - 📄 me.ts 223 B
  - 📄 project-fields.ts 1.7 KB
  - 📄 project-statuses.ts 862 B
  - 📄 projects.ts 583 B
  - 📄 run-jql.ts 437 B
  - 📄 settings.ts 3.1 KB
  - 📄 sprint.ts 6.4 KB
  - 📄 task-with-details.ts 1.1 KB
  - 📄 transition.ts 6.1 KB
  - 📄 update-description.ts 2.3 KB
  - 📄 update-issue.ts 4.0 KB
- 📁 lib/
  - 📄 adf-mentions.ts 5.0 KB
  - 📄 agile-client.ts 8.1 KB
  - 📄 auth-storage.ts 2.0 KB
  - 📄 confluence-client.ts 12.1 KB
  - 📄 epic-fields.ts 2.6 KB
  - 📄 errors.ts 437 B
  - 📄 field-resolver.ts 3.7 KB
  - 📄 jira-client.ts 39.5 KB
  - 📄 json-mode.ts 659 B
  - 📄 permissions.ts 579 B
  - 📄 settings.ts 11.8 KB
  - 📄 update-check.ts 3.0 KB
  - 📄 utils.ts 5.3 KB
  - 📄 validation.ts 9.9 KB
- 📁 types/
  - 📄 errors.ts 125 B
  - 📄 marklassian.d.ts 306 B
- 📄 cli.ts 34.2 KB
📁 tests/
- 📁 __mocks__/
  - 📄 jira.js.ts 114 B
  - 📄 marklassian.ts 110 B
  - 📄 mdast-util-from-adf.ts 84 B
  - 📄 mdast-util-to-markdown.ts 77 B
- 📁 e2e/
  - 📄 conftest.py 1.9 KB
  - 📄 test_auth.py 3.0 KB
  - 📄 test_confluence_operations.py 1.5 KB
  - 📄 test_jira_operations.py 6.4 KB
  - 📄 test_no_multi_org.py 3.9 KB
  - 📄 test_settings.py 1.0 KB
- 📁 integration/
  - 📄 create-task.integration.test.ts 1.1 KB
  - 📄 epic.integration.test.ts 5.5 KB
  - 📄 get-users.integration.test.ts 587 B
  - 📄 integration-test-utils.ts 681 B
  - 📄 issue-links.integration.test.ts 4.4 KB
  - 📄 issue.integration.test.ts 1.1 KB
  - 📄 me.integration.test.ts 610 B
  - 📄 project-fields.integration.test.ts 2.9 KB
  - 📄 projects.integration.test.ts 595 B
  - 📄 transition.integration.test.ts 3.4 KB
  - 📄 update-issue.integration.test.ts 3.3 KB
- 📄 about.test.ts 1.4 KB
- 📄 add-comment.test.ts 5.6 KB
- 📄 adf-mentions.test.ts 3.9 KB
- 📄 agile-client.test.ts 14.2 KB
- 📄 attach.test.ts 13.9 KB
- 📄 auth-logout.test.ts 1.6 KB
- 📄 auth-storage.test.ts 3.6 KB
- 📄 auth.test.ts 3.4 KB
- 📄 backlog.test.ts 2.5 KB
- 📄 board.test.ts 7.4 KB
- 📄 cli-org-cleanup.test.ts 1.6 KB
- 📄 cli-permissions.test.ts 5.6 KB
- 📄 complex-settings.test.ts 10.2 KB
- 📄 confluence-commands.test.ts 11.1 KB
- 📄 confluence-search.test.ts 2.4 KB
- 📄 confluence-urls.test.ts 3.7 KB
- 📄 confluence.test.ts 8.5 KB
- 📄 create-task.test.ts 10.3 KB
- 📄 dotenv_output.test.ts 968 B
- 📄 dynamic-help.test.ts 3.7 KB
- 📄 epic-commands.test.ts 10.2 KB
- 📄 epic-fields.test.ts 6.6 KB
- 📄 errors.test.ts 763 B
- 📄 field-resolver.test.ts 7.2 KB
- 📄 get-issue-statistics.test.ts 4.5 KB
- 📄 get-person-worklog.test.ts 6.9 KB
- 📄 get-users.test.ts 2.1 KB
- 📄 help-descriptions.test.ts 1.4 KB
- 📄 issue-47-defaults.test.ts 1.6 KB
- 📄 issue-54-comprehensive.test.ts 4.2 KB
- 📄 issue-54-reproduction.test.ts 2.8 KB
- 📄 issue-66-reproduction-client.test.ts 1.5 KB
- 📄 issue-66-reproduction.test.ts 2.2 KB
- 📄 issue-83-settings-help.test.ts 847 B
- 📄 issue-86-reproduction.test.ts 2.0 KB
- 📄 issue-95-repro.test.ts 5.4 KB
- 📄 issue-97-repro.test.ts 1.1 KB
- 📄 issue-assign.test.ts 2.5 KB
- 📄 issue-link-client.test.ts 7.5 KB
- 📄 issue-link-commands.test.ts 11.7 KB
- 📄 jir-81-remove-human-features.test.ts 12.8 KB
- 📄 jira-client.test.ts 30.1 KB
- 📄 json-mode.test.ts 5.5 KB
- 📄 json-output-integration.test.ts 7.8 KB
- 📄 label-commands.test.ts 3.6 KB
- 📄 list-colleagues.test.ts 2.9 KB
- 📄 list-issue-types.test.ts 2.2 KB
- 📄 list-transitions.test.ts 5.6 KB
- 📄 me.test.ts 1.4 KB
- 📄 non-interactive-auth.test.ts 4.2 KB
- 📄 project-fields.test.ts 6.7 KB
- 📄 project-statuses.test.ts 2.1 KB
- 📄 projects.test.ts 5.4 KB
- 📄 README.md 2.4 KB
- 📄 run-jql.test.ts 2.7 KB
- 📄 service-account-auth.test.ts 7.5 KB
- 📄 settings-command.test.ts 9.1 KB
- 📄 settings.test.ts 14.3 KB
- 📄 single-org-cleanup.test.ts 4.0 KB
- 📄 sprint.test.ts 12.6 KB
- 📄 statistics.test.ts 3.1 KB
- 📄 task-with-details.test.ts 2.6 KB
- 📄 transition.test.ts 11.5 KB
- 📄 update-check.test.ts 4.1 KB
- 📄 update-description.test.ts 6.6 KB
- 📄 update-epic.test.ts 3.2 KB
- 📄 update-issue.test.ts 9.5 KB
- 📄 utils-date.test.ts 1.2 KB
- 📄 utils.test.ts 8.3 KB
- 📄 validation.test.ts 9.3 KB
📁 tests_e2e/
- 📄 test_attachments.py 13.8 KB
- 📄 test_issue_linking.py 9.1 KB
- 📄 test_json_flag.py 25.5 KB
- 📄 test_remove_human_features.py 13.6 KB
- 📄 test_rich_issue_create_update.py 18.5 KB
- 📄 test_transitions.py 9.4 KB
📄 .gitignore 96 B
📄 .npmignore 256 B
📄 advanced-installation.md 982 B
📄 all_avaliable_commands.md 10.8 KB
📄 jest.config.js 737 B
📄 LICENSE 11.1 KB
📄 package-lock.json 117.4 KB
📄 package.json 1.7 KB
📄 README.md 6.0 KB
📄 settings.yaml 578 B
📄 SKILL.md 5.9 KB
📄 starter-installation.md 1.1 KB
📄 tsconfig.json 456 B
📄 vitest.config.ts 227 B

SKILL.md

# Jira AI CLI - AI Agent Skill

An AI-friendly CLI for Jira designed for maximum efficiency and security. All output is structured JSON — no human-readable formatting, no interactive prompts.

## Why Use Jira AI CLI?
- **Efficiency:** Consumes significantly fewer tokens than Jira MCP or similar tools by eliminating redundant context data.
- **Security:** Bullet-proof security by restricting AI actions to only what you permit.

## Installation & Setup

```bash
npm install -g jira-ai
```

### Authentication
Provide credentials via JSON string or `.env` file (no interactive prompts):

```bash
jira-ai auth --from-json '{"url":"https://your-domain.atlassian.net","email":"you@example.com","apikey":"your-api-token"}'
```

Or use a `.env` file for service accounts:
```bash
jira-ai auth --from-file path/to/.env
```

### Setup Settings & Restrictions
```bash
jira-ai settings --help
```

## JSON Output

All commands always output structured JSON. Use global flags to control formatting:

- Default: pretty-printed JSON (2-space indentation)
- `--compact`: single-line JSON for maximum token efficiency

```bash
jira-ai issue get PROJ-123
jira-ai --compact issue get PROJ-123
jira-ai project list
jira-ai issue search "project = PROJ AND status = Open"
```

Errors are returned as structured JSON to stdout:
```json
{ "error": true, "message": "Issue not found", "hints": ["Check the issue key"], "exitCode": 1 }
```

## Command Overview

### Issues
- `issue get <issue-id>`: Retrieve issue details. Response includes an `attachments` array with id, filename, size, author, and created timestamp.
- `issue create`: Create a new issue. Supports `--title`, `--project`, `--issue-type`, `--parent` (for subtasks), `--priority`, `--description`, `--description-file`, `--labels`, `--component`, `--fix-version`, `--due-date`, `--assignee`, `--custom-field`.
- `issue search <jql>`: Execute JQL search.
- `issue transition <issue-id> <status>`: Change issue status. Supports `--resolution <name>`, `--comment <text>`, `--comment-file <path>`, `--assignee <email-or-name>`, `--fix-version <name>`, `--custom-field "Field Name=value"`.
- `issue transitions <issue-id>`: List available transitions for an issue, including required fields. Supports `--required-only`.
- `issue update <issue-id>`: Update one or more fields of an issue. Supports `--priority`, `--summary`, `--description`, `--from-file`, `--labels`, `--clear-labels`, `--component`, `--fix-version`, `--due-date`, `--assignee`, `--custom-field`.
- `issue comment <issue-id>`: Add comment from Markdown file.
- `issue assign <issue-id> <account-id>`: Assign issue.
- `issue label <add|remove> <issue-id> <labels>`: Manage labels.
- `issue link types`: List all available issue link types.
- `issue link list <issue-key>`: List all links (inward + outward) for an issue.
- `issue link create <source-key> <link-type> <target-key>`: Create a link between two issues (e.g., `"Blocks"`, `"Relates"`).
- `issue link delete <source-key> --target <target-key>`: Delete a link between two issues.
- `issue attach upload <issue-key> --file <path> [--file <path>]...`: Upload one or more files as attachments. Returns attachment metadata (id, filename, size, mimeType, author, created).
- `issue attach list <issue-key>`: List all attachments on an issue with metadata (id, filename, size, author, created).
- `issue attach download <issue-key> --id <attachment-id> [--output <path>]`: Download an attachment by ID. Saves to the specified path, or defaults to the attachment filename in the current directory.
- `issue attach delete <issue-key> --id <attachment-id>`: Remove an attachment from an issue.

### Projects & Users
- `project list`: List accessible projects.
- `project fields <project-key>`: Discover available fields including custom fields. Use `--type <issue-type>` to filter by issue type, `--custom` for custom fields only, `--search <term>` to search by name.
- `user search [project-key]`: Find users.
- `user worklog <user> <timeframe>`: Get worklogs.

### Epics
- `epic list <project-key>`: List epics in a project (`--done` to include completed, `--max <n>` to limit).
- `epic get <epic-key>`: Get full epic details.
- `epic create <project-key>`: Create a new epic (`--name`, `--summary` required; `--description`, `--labels` optional).
- `epic update <epic-key>`: Update epic name and/or summary.
- `epic issues <epic-key>`: List issues belonging to an epic (`--max <n>` to limit).
- `epic link <issue-key>`: Link an issue to an epic (`--epic <epic-key>`).
- `epic unlink <issue-key>`: Remove an issue from its epic.
- `epic progress <epic-key>`: Show epic completion progress with visual bar.

### Boards, Sprints & Backlog
- `board list [--project <key>] [--type <type>]`: List accessible boards.
- `board get <board-id>`: Get board details.
- `board config <board-id>`: Get board configuration (columns, filter, rank field).
- `board issues <board-id>`: List issues on a board (`--jql`, `--max`).
- `board rank --issues <keys> --before <key>|--after <key>`: Rank issues on a board.
- `sprint list <board-id> [--state <state>]`: List sprints for a board.
- `sprint get <sprint-id>`: Get sprint details.
- `sprint create <board-id> --name <name>`: Create a sprint (`--goal`, `--start`, `--end` optional).
- `sprint start <sprint-id>`: Start a future sprint.
- `sprint complete <sprint-id>`: Complete an active sprint.
- `sprint update <sprint-id>`: Update sprint (`--name`, `--goal`, `--start`, `--end`).
- `sprint delete <sprint-id>`: Delete a sprint.
- `sprint issues <sprint-id>`: List issues in a sprint (`--jql`, `--max`).
- `sprint move <sprint-id> --issues <keys>`: Move issues to a sprint.
- `backlog move --issues <keys>`: Move issues to the backlog.

### Confluence
- `confl get <url>`: Retrieve Confluence page content.
- `confl create <space> <title>`: Create a new page.
- `confl update <url>`: Update page content from Markdown.

For a full list of commands, refer to the [Available Commands](https://github.com/festoinc/jira-ai/blob/main/all_avaliable_commands.md) documentation.

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

jira-ai

Directory Structure

SKILL.md

Report

Notice