Jira-AI 技能

jira-ai 技能提供了对 Atlassian Jira 和 Confluence 平台的全面命令行访问，使代理能够高效地管理问题、项目、用户和文档。

安装

要安装 jira-ai，请运行：

npm install -g jira-ai

身份验证设置

在使用 jira-ai 之前，你需要配置你的 Jira 凭据：

1. 创建一个.env文件，包含以下值：

   JIRA_HOST=your-domain.atlassian.net
   JIRA_USER_EMAIL=your-email@example.com
   JIRA_API_TOKEN=your-api-token
   

2. 使用 .env 文件进行身份验证：

   jira-ai auth --from-file path/to/.env
   

配置

你可以使用 settings 命令管理设置：

jira-ai settings --help

从 YAML 文件应用设置：

jira-ai settings --apply my-settings.yaml

验证设置：

jira-ai settings --validate my-settings.yaml

命令概述

顶级命令

问题管理 (issue)

项目管理 (项目)

用户管理 (用户)

组织管理 (org)

Confluence命令 (confl命令

搜索分配给当前用户的问题

获取特定问题的详细信息

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

List all projects

jira-ai project list

获取用户的工作日志

jira-ai user worklog john.doe@example.com 2w

配置选项

jira-ai工具支持通过配置文件进行广泛的自定义设置。您可以定义：

• 允许访问的Jira项目
• 允许执行的命令
• 允许访问的Confluence空间
• 各类操作的默认行为

配置结构示例：

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

优势特性

• 高效API调用：执行常规操作时最大限度减少所需API调用次数
• 批量操作：单次处理多项任务以降低API使用频率
• 智能筛选：运用JQL查询语言精准获取所需数据
• 本地预处理：在向Jira发送定向请求前于本地完成操作处理
• 基于配置的访问控制：通过定义允许执行的命令和项目防止越权操作
• 定向命令执行只获取必要信息，以减少负载大小和API使用

安全注意事项

• 将API令牌安全地存储在环境文件中
• 使用基于配置的访问控制来限制操作
• 定期轮换API令牌
• 将操作权限限制在所需的最低限度