Home | Index
red-cli is a small command-line client for Redmine. It provides subcommands to authenticate, list and manage projects and issues, and to configure local settings.
NEW: Red-cli now supports multi-instance management! Work with multiple Redmine servers simultaneously using the --rid flag. See the Multi-Instance Guide for details.
Read the full reference documentation for all commands and options below.
- red-cli — Top-level CLI reference
- config — Configuration options and files
- multi-instance — Multi-instance support guide
Use red-cli completion -s <shell> to generate completion scripts for bash, zsh, fish and PowerShell. See completion for details and install instructions.
-
Login using Username and password or API key:
red-cli auth login
-
Login to multiple instances:
red-cli auth login --rid prod red-cli auth login --rid staging
-
List projects:
red-cli project list
-
List projects from a specific instance:
red-cli project list --rid staging
-
Create an issue (opens editor for description):
red-cli issue create --project 42
-
Create an issue in a specific instance:
red-cli issue create --project 42 --rid prod
-
Add a note to an issue:
red-cli issue note 123 -m "This is a note"
If you'd like dynamic shell completions (project/issue name completion), editor-based workflows, or example workflows for CI, open an issue or send a patch. This documentation is intentionally concise — see individual pages for full command reference.