easyredmine-cli Quickstart

easyredmine-cli Quickstart

Overview

easyredmine-cli interacts with EasyRedmine (Simpliciti) via the Redmine API. JSON output by default. No interactive prompts. Auth via config file or EASYREDMINE_API_KEY env var.

Commands

sc easyredmine issue show <id>

Read issue details (JSON output by default).

# JSON (default) — agent-friendly
sc easyredmine issue show 61809

# Human-readable
sc easyredmine issue show 61809 --human

sc easyredmine issue comment <id> --text "<text>"

Add a comment. JSON response by default.

sc easyredmine issue comment 61809 --text "Comment from agent"

sc easyredmine issue edit <id> --description "<text>"

Edit description. JSON response by default.

sc easyredmine issue edit 61809 --description "<p>Updated</p>"

sc easyredmine issue status <id> --status-id <status_id>

Change issue status. JSON response by default.

sc easyredmine issue status 61809 --status-id 51

sc easyredmine issue assign <id> --assigned-to-id <user_id>

Assign issue to a user. JSON response by default.

sc easyredmine issue assign 61809 --assigned-to-id 199

sc easyredmine user search "<query>" --project-id <id>

Search users, groups, and roles within a project. JSON response by default.

# Search for QA team
sc easyredmine user search "QA" --project-id 1111

# Search for developers
sc easyredmine user search "ENVIRONNEMENT" --project-id 1111

Agent workflow: When asked to "Assign to QA", search first to get the ID, then assign:

# 1. Find QA team ID
sc easyredmine user search "QA" --project-id 1111
# → {"results":[{"id":46,"fullname":"Equipe QA Env (Group)"},...]}

# 2. Assign using the ID
sc easyredmine issue assign 62507 --assigned-to-id 46

sc easyredmine update [--check-only]

Check for updates from GitHub releases and optionally auto-update the global installation.

# Check for updates only
sc easyredmine update --check-only

# Check and install if update available
sc easyredmine update

Note: If no GitHub releases exist yet (new repository), the command provides manual update instructions.

sc easyredmine issue search "<phrase>"

Smart search across all open issues. Breaks phrase into words, matches each word against issue subjects, deduplicates, and ranks by number of word matches.

# JSON (default)
sc easyredmine issue search "correction statut message"

# Human-readable with custom limit
sc easyredmine issue search "correction statut" --limit 5 --human

Performance tip: Use --current-month when possible. It fetches ~100 issues (1 page) instead of 3,630 (37 pages) — 30x faster. Progress events on stderr.

Auth

Three ways, highest precedence first:

1. EASYREDMINE_API_KEY env var (best for agents — no config file needed)
2. EASYREDMINE_BASE_URL env var overrides base URL
3. Config file at ~/.config/easyredmine-cli/config.json

# Config file approach
easyredmine-cli config set --api-key <key>

# Env var approach (no file needed)
EASYREDMINE_API_KEY=<key> sc easyredmine issue show 61809

Semantic exit codes

Errors on stderr as structured JSON. Agents use exit code to decide next action:

• 85 → fix input/args
• 92 → resource not found, try different ID
• 105 → transient API error, retry with backoff