README
¶
redmine-cli
A command-line interface for Redmine project management.
Installation · Getting Started · AI Agents
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
redmine-cli ships an Agent Skill (the open SKILL.md standard, supported by 35+ agents) and a built-in MCP server. Both are vendor-neutral - pick the one-liner that matches your tool:
| Tool | One-line install |
|---|---|
| Any agent (skill) | npx skills add aarondpn/redmine-cli |
| Any MCP host | redmine mcp serve (then add to host config) |
| Claude Code | /plugin marketplace add aarondpn/redmine-cli then /plugin install redmine |
| Codex CLI | codex plugin marketplace add aarondpn/redmine-cli then /plugins (install Redmine from the added marketplace) |
| Gemini CLI | gemini extensions install https://github.com/aarondpn/redmine-cli |
The skill teaches the agent the non-obvious parts of the CLI (output formats, name resolution, pagination, common workflows). The MCP server exposes the same operations as typed tool calls, read-only by default, with per-group / per-tool allow- and deny-lists.
Full configuration, host-specific snippets (Claude Desktop, Cursor, Zed, VS Code), and write-tool gating: see the AI Agent Integration guide.
Development
Local E2E testing against a real Redmine instance (Docker, supported on Redmine 4.2, 5.1, 6.1): see e2e/README.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
mcpgen
command
|
|
|
redmine
command
|
|
|
Package e2e contains build-tagged end-to-end tests that exercise the CLI against a real Redmine instance started locally via Docker Compose.
|
Package e2e contains build-tagged end-to-end tests that exercise the CLI against a real Redmine instance started locally via Docker Compose. |
|
internal
|
|
|
cmd/attachment
Package attachment implements the `redmine attachments` command group, which surfaces the Redmine REST Attachments API so users (and agents) can inspect attachment metadata and download the raw bytes without dropping down to `redmine api` plus a manual `curl` with a hand-extracted API key.
|
Package attachment implements the `redmine attachments` command group, which surfaces the Redmine REST Attachments API so users (and agents) can inspect attachment metadata and download the raw bytes without dropping down to `redmine api` plus a manual `curl` with a hand-extracted API key. |
|
cmd/files
Package files implements the `redmine files` command group, which surfaces the Redmine REST Files API so users can list and upload project-level artifacts without dropping down to `redmine api`.
|
Package files implements the `redmine files` command group, which surfaces the Redmine REST Files API so users can list and upload project-level artifacts without dropping down to `redmine api`. |
|
cmd/mcp
Package mcp wires the Model Context Protocol server subcommand into the Redmine CLI.
|
Package mcp wires the Model Context Protocol server subcommand into the Redmine CLI. |
|
mcpserver
Package mcpserver implements a Model Context Protocol server that exposes the redmine-cli API surface to MCP-compatible hosts (Claude Desktop, Claude Code, Cursor, etc.).
|
Package mcpserver implements a Model Context Protocol server that exposes the redmine-cli API surface to MCP-compatible hosts (Claude Desktop, Claude Code, Cursor, etc.). |
|
testutil
Package testutil provides shared test helpers for command-layer tests.
|
Package testutil provides shared test helpers for command-layer tests. |