Skip to content

aarondpn/redmine-cli

Repository files navigation

redmine-cli

A command-line interface for Redmine project management.

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@latest

Manual Download

Grab the latest release for your platform from GitHub Releases:

Platform Architecture Download
Linux x86_64 redmine-linux-amd64.tar.gz
Linux ARM64 redmine-linux-arm64.tar.gz
macOS Intel redmine-darwin-amd64.tar.gz
macOS Apple Silicon redmine-darwin-arm64.tar.gz
Windows x86_64 redmine-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 init

# List issues
redmine issue list

# View a specific issue
redmine issue view 123

# Log time
redmine time log

Run redmine --help to see all available commands.

Using with AI Agents

redmine-cli ships with an agent skill that teaches AI coding agents (Claude Code, Cursor, etc.) how to use the CLI effectively. The skill covers output formats, pagination, filtering, name resolution, and common workflows -- so the agent knows to use -o json, resolve ambiguous values by querying first, and use the right flags without guessing.

Install the skill

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

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

This uses the skills CLI under the hood (npx skills add), which requires Node.js.

What the agent learns

Once installed, the agent will:

  • Use -o json for all commands to get machine-readable output
  • Keep stderr separate when capturing -o json; JSON is written only to stdout
  • Query available options (trackers, statuses, versions, etc.) before creating or updating issues, rather than guessing values
  • Present options to the user for selection when values are ambiguous
  • Handle pagination with --limit and --offset
  • Use name resolution (e.g. --assignee "John Smith" instead of --assignee 42)
  • Use the me shorthand for --assignee me

Manual setup

If you prefer not to use the skill installer, you can add the skill reference directly to your agent configuration. For Claude Code, add to .claude/settings.json:

{
  "skills": ["aarondpn/redmine-cli:redmine-cli"]
}

Or copy the contents of skills/redmine-cli/SKILL.md into your project's CLAUDE.md or equivalent agent instructions file.

About

A command-line interface for Redmine project management.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages