The jira-ai skill provides comprehensive command-line access to Atlassian Jira and Confluence platforms, allowing agents to manage issues, projects, users, and documentation efficiently.
To install jira-ai, run:
npm install -g jira-ai
Before using jira-ai, you need to configure your Jira credentials:
.env file with the following values:```
JIRA_HOST=your-domain.atlassian.net
JIRA_USER_EMAIL=your-email@example.com
JIRA_API_TOKEN=your-api-token
```
```bash
jira-ai auth --from-file path/to/.env
```
You can manage settings using the settings command:
jira-ai settings --help
Apply settings from a YAML file:
jira-ai settings --apply my-settings.yaml
Validate settings:
jira-ai settings --validate my-settings.yaml
| Command | Description |
|---|---|
| :--- | :--- |
jira-ai auth | Set up Jira authentication credentials |
jira-ai settings | View, validate, or apply configuration settings |
jira-ai about | Show information about the tool |
jira-ai help | Display help for commands |
issue)| Command | Description |
|---|---|
| :--- | :--- |
jira-ai issue get | Retrieve comprehensive issue data |
jira-ai issue create | Create a new Jira issue |
jira-ai issue search | Execute a JQL search query |
jira-ai issue transition | Change the status of a Jira issue |
jira-ai issue update | Update a Jira issue's description |
jira-ai issue comment | Add a new comment to a Jira issue |
jira-ai issue stats | Calculate time-based metrics for issues |
jira-ai issue assign | Assign or reassign a Jira issue |
jira-ai issue label add | Add labels to a Jira issue |
jira-ai issue label remove | Remove labels from a Jira issue |
project)| Command | Description |
|---|---|
| :--- | :--- |
jira-ai project list | List all accessible Jira projects |
jira-ai project statuses | Fetch workflow statuses for a project |
jira-ai project types | List issue types available for a project |
user)| Command | Description |
|---|---|
| :--- | :--- |
jira-ai user me | Show profile details for authenticated user |
jira-ai user search [project-key] | Search and list users |
jira-ai user worklog | Retrieve worklogs for a user |
org)| Command | Description |
|---|---|
| :--- | :--- |
jira-ai org list | List all saved Jira organization profiles |
jira-ai org use | Switch the active Jira organization profile |
jira-ai org add | Add a new Jira organization profile |
jira-ai org remove | Delete credentials for an organization |
confl)| Command | Description |
|---|---|
| :--- | :--- |
jira-ai confl get | Download Confluence page content |
jira-ai confl spaces | List all allowed Confluence spaces |
jira-ai confl pages | Display pages within a space |
jira-ai confl create | Create a new Confluence page |
jira-ai confl comment | Add a comment to a Confluence page |
jira-ai confl update | Update a Confluence page |
jira-ai issue search "assignee = currentUser()"
jira-ai issue get PROJ-123
jira-ai issue create --project "PROJ" --summary "New task" --issuetype "Story"
jira-ai issue transition PROJ-123 "In Progress"
jira-ai issue comment PROJ-123 --file comment.md
jira-ai project list
jira-ai user worklog john.doe@example.com 2w
The jira-ai tool supports extensive configuration through settings files. You can define:
Example settings structure:
defaults:
allowed-jira-projects:
- all # Allow all projects
allowed-commands:
- all # Allow all commands
allowed-confluence-spaces:
- all # Allow all Confluence spaces
organizations:
work:
allowed-jira-projects:
- PROJ # Allow specific project
- key: PM # Project-specific config
commands:
- issue.get # Only allow reading issues
filters:
participated:
was_assignee: true
allowed-commands:
- issue # All issue commands
- project.list # Only project list
- user.me # Only user me
allowed-confluence-spaces:
- DOCS
共 1 个版本