Skip to content

README.md

Latest commit

 

History

History
148 lines (102 loc) · 5.77 KB

README.md

File metadata and controls

148 lines (102 loc) · 5.77 KB

redmine-cli logo

redmine-cli

A command-line interface for Redmine project management.

English · 简体中文 · 日本語

CI Release Go License

Redmine 4.x Redmine 5.x Redmine 6.x

Installation · Getting Started · Agent Skill · MCP Server

Installation

Homebrew (macOS & Linux)

brew tap aarondpn/tap
brew install redmine

This also installs shell completions for bash, zsh, and fish.

Quick Install Script

curl -fsSL https://raw.githubusercontent.com/aarondpn/redmine-cli/main/install.sh | bash

Auto-detects your OS and architecture, downloads the latest release with checksum verification, and installs to ~/.local/bin.

Install with Go

go install github.com/aarondpn/redmine-cli/v2/cmd/redmine@latest

Manual Download

Grab the latest release for your platform from GitHub Releases:

Platform Architecture Download
Linux x86_64 redmine-cli-linux-amd64.tar.gz
Linux ARM64 redmine-cli-linux-arm64.tar.gz
macOS Intel redmine-cli-darwin-amd64.tar.gz
macOS Apple Silicon redmine-cli-darwin-arm64.tar.gz
Windows x86_64 redmine-cli-windows-amd64.zip

Updating

redmine update

Downloads and verifies the latest release via SHA256 checksum before replacing the binary.

Getting Started

# Configure your Redmine server and API key
redmine auth login

# List issues
redmine issues list

# View a specific issue
redmine issues view 123

# Log time
redmine time log

Run redmine --help to see all available commands.

Using with AI Agents

Two integration paths, depending on how your agent talks to tools:

Agent Skill

For agents that load skills as instructions, redmine-cli ships with a skill that teaches the agent how to drive the CLI effectively -- output formats, pagination, filtering, name resolution, and common workflows -- so it uses -o json, resolves ambiguous values by querying first, and picks the right flags without guessing.

# Install globally (available in all projects)
redmine install-skill --global

# Or install for the current project only
redmine install-skill

This uses the skills.sh installer (npx skills add) under the hood, which requires Node.js on your PATH.

See skills/redmine-cli/SKILL.md for the full skill contents -- what the agent learns, and what you can copy into your agent's instructions file if you prefer not to use the installer.

MCP Server

For hosts that speak the Model Context Protocol, redmine mcp serve exposes the CLI as an MCP server over stdio, reusing the same profile-backed authentication as every other redmine command.

  • Read-only by default. Mutating tools are only registered when --enable-writes is passed; without the flag they never appear in tools/list.
  • Authentication reuses the active profile (or --profile, --server/--api-key, REDMINE_* env vars).

Write tools are destructive; prefer leaving them disabled unless the host surfaces a per-call approval UI you trust.

Local E2E Testing

If you want to exercise the CLI against a real Redmine instance locally, the repo now includes a Docker-based e2e harness under e2e/README.md.

The setup uses Docker Official Images with Postgres and can target the supported Redmine lines 4.2, 5.1, and 6.1. By default it uses 6.1 on http://127.0.0.1:3000. If you want a specific supported line, set E2E_VERSION=... before the Make target. If you want to point the harness at a custom image later, set REDMINE_IMAGE=....

make e2e-up
make e2e-config
make e2e-test
make e2e-down

Or run the full supported-version matrix:

make e2e-matrix

The Go e2e suite creates a real project and issue, checks list/get flows, and verifies close/reopen behavior against the local instance.