Skip to main content

@webframp/redmine

v2026.04.22.3

Redmine issue tracker integration - manage issues, projects, and workflows.

Provides model methods for CRUD operations on Redmine issues (themes, stories, tasks), project queries, status/tracker/user lookups, and custom field access. Includes reports for flow metrics and sprint summaries, plus a scaffold-story workflow for creating stories with child tasks.

Quick Start

swamp extension pull @webframp/redmine
swamp model create @webframp/redmine tracker \
  --global-arg host=https://your-redmine.example.org \
  --global-arg apiKey=YOUR_API_KEY \
  --global-arg project=your-project

Repository

https://github.com/webframp/swamp-extensions

Labels

redmineissue-trackerworkflowkanbanproject-management

Quality score

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @webframp/redmine

@webframp/redminev2026.04.22.1redmine/redmine.ts

Global Arguments

ArgumentTypeDescription
hoststringRedmine instance URL (e.g. https://redmine.example.com)
apiKeystringRedmine API key (40-character hex string)
projectstringDefault project identifier
username?stringRedmine username for X-Redmine-Username header (required by some ingress configurations)
list_statusesList all issue statuses
list_trackersList all trackers
list_projectsList all accessible projects
list_usersList project memberships (users and groups with their roles)
ArgumentTypeDescription
project?stringProject identifier (defaults to global project arg)
list_custom_fieldsList all custom field definitions
list_issuesList issues matching filters
ArgumentTypeDescription
project?stringProject identifier
trackerId?numberFilter by tracker ID
statusId?unionFilter by status ID or open/closed/*
assignedToId?unionFilter by assignee ID or 'me'
parentId?numberFilter by parent issue ID
limit?numberMax results (default 25, max 100)
sort?stringSort field (e.g., 'updated_on:desc')
get_issueGet a single issue with journals and children
ArgumentTypeDescription
issueIdnumberIssue ID
create_issueCreate a new issue
ArgumentTypeDescription
subjectstringIssue subject
project?stringProject identifier
trackerId?numberTracker ID
statusId?numberStatus ID
priorityId?numberPriority ID
assignedToId?numberAssignee user ID
description?stringIssue description
parentIssueId?numberParent issue ID
estimatedHours?numberEstimated hours
customFields?arrayCustom field values
update_issueUpdate an existing issue
ArgumentTypeDescription
issueIdnumberIssue ID to update
subject?stringNew subject
trackerId?numberNew tracker ID
statusId?numberNew status ID
priorityId?numberNew priority ID
assignedToId?numberNew assignee user ID
description?stringNew description
parentIssueId?numberNew parent issue ID
estimatedHours?numberNew estimated hours
doneRatio?numberPercent done (0-100)
dueDate?stringUpdated due date (YYYY-MM-DD)
notes?stringJournal note to add
customFields?arrayCustom field values to update

Resources

issues(30m)— List of issues matching query filters
issue_detail(30m)— Single issue with journals and children
projects(1h)— List of accessible projects
statuses(infinite)— Issue statuses (id, name, isClosed)
trackers(infinite)— Trackers (id, name, defaultStatus, description)
users(1h)— Project memberships (users and groups with roles)
custom_fields(infinite)— Custom field definitions (id, name, fieldFormat, possibleValues, ...)

@webframp/scaffold-storyscaffold-story-001

Create a Redmine story with structured fields. Creates a parent story issue using the story template format. Child tasks can be added afterward using the create_issue method with the parentId set to the created story's ID.

create-storyCreate the parent story issue in Redmine
1.create-parenttracker.create_issue— Create the story with provided details

@webframp/flow-metrics-reportworkflow
flow_metrics_report.ts

Computes cycle time, lead time, throughput, and WIP age from Redmine issue journals

redmineflow-metricskanbancontinuous-improvement
@webframp/sprint-summary-reportworkflow
sprint_summary_report.ts

Summarizes current sprint status with breakdowns by status, tracker, and assignee

redminesprintkanbanstatus