# rmn

> rmnはGo言語で書かれた非公式のRedmineコマンドラインクライアントです。Redmine REST APIの主要リソース（チケット、プロジェクト、ユーザー、バージョン、作業時間、メンバーシップ、Wikiページ、トラッカー、チケットステータス）をカバーし、AIエージェント連携用の内蔵Model Context Protocol（MCP）サーバーも提供します。

> 警告: このプロジェクトは実験的な段階です。APIおよびCLIインターフェースはまだ安定しておらず、予告なく破壊的変更が加わる可能性があります。

## ドキュメント

- [ドキュメントサイト](https://nbifrye.github.io/rmn/ja/): 完全なドキュメントサイト（日本語）
- [GitHubリポジトリ](https://github.com/nbifrye/rmn): ソースコード、Issue、リリース
- [LLM向け完全ドキュメント](https://nbifrye.github.io/rmn/llms-full-ja.txt): プレーンテキスト形式の完全なドキュメント（日本語）

## インストール

Homebrew（`brew tap nbifrye/rmn https://github.com/nbifrye/rmn.git && brew install nbifrye/rmn/rmn`）、mise（`mise use -g ubi:nbifrye/rmn`）、Nix（`nix profile install github:nbifrye/rmn`）、Go（`go install github.com/nbifrye/rmn/cmd/rmn@latest`）、またはGitHub Releasesからビルド済みバイナリをダウンロードしてインストールできます。

## 設定

`rmn auth login --url https://your-redmine.example.com --api-key YOUR_API_KEY` で認証を設定します。設定は `~/.config/rmn/config.json`（XDG準拠）に保存されます。`--redmine-url` と `--api-key` フラグでコマンド単位のオーバーライドが可能です。

## CLIコマンド

チケット:
- `rmn issue list`（エイリアス: `ls`）— フィルタ付きチケット一覧表示: `-p` プロジェクト、`-s` ステータス、`-a` 担当者、`-t` トラッカー、`--sort`、`-l` 上限、`--offset`
- `rmn issue view <id>`（エイリアス: `show`, `get`）— チケットの詳細表示
- `rmn issue create`（エイリアス: `new`）— チケット作成: `-p` プロジェクト（必須）、`-s` 題名（必須）、`-d` 説明、`-t` トラッカー、`--priority`、`-a` 担当者
- `rmn issue update <id>` — チケットのフィールドを更新、`-n` でノートを追加
- `rmn issue close <id>` — チケットをクローズ（デフォルトステータス5）、オプションで `--status` と `-n`
- `rmn issue delete <id>`（エイリアス: `rm`）— チケットを削除、`-y` で確認をスキップ

プロジェクト:
- `rmn project list` / `view <id>` / `create` / `update` / `archive` / `unarchive` / `delete <id>`

ユーザー:
- `rmn user list` / `view <id|me>` — ユーザーの一覧と詳細表示（`me` で現在のAPIキーに対応するユーザー）

バージョン:
- `rmn version list -p <project>` / `view <id>` / `create -p <project> --name` / `update <id>` / `delete <id>`

作業時間:
- `rmn time-entry list` / `view <id>` / `create --issue|-p --hours` / `update <id>` / `delete <id>`

メンバーシップ:
- `rmn membership list -p <project>` / `view <id>` / `create -p --user --role` / `update <id> --role` / `delete <id>`

Wikiページ:
- `rmn wiki list -p <project>` / `view <title> -p <project>` / `create <title> -p --text` / `update <title> -p --text` / `delete <title> -p`

参照データ:
- `rmn tracker list`
- `rmn status list`

認証とグローバル:
- `rmn auth login` / `rmn auth status`
- グローバルフラグ: `--output`（table/json）、`--redmine-url`、`--api-key`

## MCPサーバー

`rmn mcp serve`（stdioトランスポート）で起動。利用可能なツール:
- チケット: `list_issues`、`get_issue`、`create_issue`、`update_issue`、`delete_issue`
- プロジェクト: `list_projects`、`get_project`、`create_project`、`update_project`、`archive_project`、`unarchive_project`、`delete_project`
- ユーザー: `list_users`、`get_user`、`get_current_user`
- バージョン: `list_versions`、`get_version`、`create_version`、`update_version`、`delete_version`
- 作業時間: `list_time_entries`、`get_time_entry`、`create_time_entry`、`update_time_entry`、`delete_time_entry`
- メンバーシップ: `list_memberships`、`get_membership`、`create_membership`、`update_membership`、`delete_membership`
- Wiki: `list_wiki_pages`、`get_wiki_page`、`create_or_update_wiki_page`、`delete_wiki_page`
- 参照データ: `list_trackers`、`list_issue_statuses`

各ツールにはMCPアノテーション（readOnlyHint, destructiveHint, idempotentHint, openWorldHint）が含まれます。

Claude Codeでの設定:
```json
{
  "mcpServers": {
    "rmn-redmine": {
      "command": "rmn",
      "args": ["mcp", "serve"]
    }
  }
}
```

## その他

- [ライセンス: MIT](https://github.com/nbifrye/rmn/blob/main/LICENSE)