CLI UtilitiesDocumentedScanned

jiraandconfluence

CLI tool for interacting with Atlassian Jira and Confluence

Share:

Installation

npx clawhub@latest install jiraandconfluence

View the full skill documentation and source below.

Documentation

Jira-AI Skill

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.

Installation

To install jira-ai, run:

npm install -g jira-ai

Authentication Setup

Before using jira-ai, you need to configure your Jira credentials:

  • Create a .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

  • Authenticate using the .env file:

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

    Configuration

    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

    Commands Overview

    Top-Level Commands

    CommandDescription
    :---:---
    jira-ai authSet up Jira authentication credentials
    jira-ai settingsView, validate, or apply configuration settings
    jira-ai aboutShow information about the tool
    jira-ai helpDisplay help for commands

    Issue Management (issue)

    CommandDescription
    :---:---
    jira-ai issue get Retrieve comprehensive issue data
    jira-ai issue createCreate 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 Management (project)

    CommandDescription
    :---:---
    jira-ai project listList 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 Management (user)

    CommandDescription
    :---:---
    jira-ai user meShow profile details for authenticated user
    jira-ai user search [project-key]Search and list users
    jira-ai user worklog Retrieve worklogs for a user

    Organization Management (org)

    CommandDescription
    :---:---
    jira-ai org listList 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

    Confluence Commands (confl)

    CommandDescription
    :---:---
    jira-ai confl get Download Confluence page content
    jira-ai confl spacesList all allowed Confluence spaces
    jira-ai confl pages Display pages within a space
    jira-ai confl create