Skip to content

ntxinh/redmine-kit

Repository files navigation

redmine-kit (rmk)

A small terminal CLI for managing Redmine issues from the command line.

Install

Bootstrap the toolchain (one-time, installs the Python and uv versions pinned in mise.toml):

mise install

Install rmk globally:

uv tool install .

Or for development (uses the local virtualenv):

uv sync --all-extras --group dev
uv run rmk --help

Configure

Copy .env.example to .env and fill in your Redmine API key:

cp .env.example .env
$EDITOR .env
Variable Required Default
REDMINE_API_KEY yes
REDMINE_BASE_URL no https://redmine.myapp.com
REDMINE_PROJECT_ID no 211

You can find your API key in Redmine under Account → API access key.

Commands

rmk list

List issues assigned to you (open / in-progress / reopened, most recent first).

rmk list
rmk list --limit 50
rmk list --status 1,2,4,5

rmk show <issue_id>

Show full issue details. If the issue has image attachments, you'll be prompted to download and open them in your default image viewer.

rmk show 1234

Downloaded images are saved to ./images/<issue_id>_<filename>.

rmk take <issue_id>

Assign an issue to yourself. Status unchanged.

rmk start <issue_id>

Set an issue to In Progress. Assignee unchanged.

rmk open <issue_id>

Set an issue to Open. Assignee unchanged.

rmk resolve <issue_id>

Mark an issue Resolved and reassign it back to its original author.

rmk reject <issue_id>

Mark an issue Rejected and reassign it back to its original author.

Exit codes

Code Meaning
0 success
1 unexpected error (re-run with --verbose for traceback)
2 configuration error (e.g., missing REDMINE_API_KEY)
4 issue not found
5 authentication failed
6 network error
7 Redmine API error

Development

mise install                      # tool versions (one-time)
uv sync --all-extras --group dev  # python deps
uv run pytest                     # tests
uv run ruff check .               # lint
uv run black --check .            # format check
uv run isort --check-only .       # import order check

CI runs all of the above on every push and pull request.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages