Skip to content

muxx/redmine-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

redmine-cli

A Redmine CLI tool bringing Redmine to your command line.

Built based on https://d-yoshi.github.io/redmine-openapi/ (repo).

Usage

redmine auth login --profile work --host https://redmine.example.com --api-key "$REDMINE_API_KEY"
redmine auth login --profile client --host https://client-redmine.example.com --api-key "$CLIENT_REDMINE_API_KEY"
redmine auth list
redmine auth use work
redmine auth status
redmine --profile client issue list --limit 20
redmine issue list --limit 20
redmine issue show 123 --include journals
redmine issue create --project-id my-project --subject "Fix checkout"

Full generated usage documentation is in docs/usage.md.

Install

Homebrew

brew install muxx/tap/redmine-cli
redmine --version

The Homebrew formula is named redmine-cli; it installs the redmine executable.

mise GitHub backend

mise use -g github:muxx/redmine-cli
redmine --version

Go install

This method requires Go to be installed on your system.

go install github.com/muxx/redmine-cli/cmd/redmine@latest
redmine --version

GitHub release archive

Download the archive for your OS and architecture from the latest release.

Archive names use this format:

redmine_<version>_<os>_<arch>.tar.gz
redmine_<version>_windows_<arch>.zip

Example for macOS Apple Silicon:

VERSION=v0.2.0
curl -LO "https://github.com/muxx/redmine-cli/releases/download/${VERSION}/redmine_${VERSION}_darwin_arm64.tar.gz"
tar -xzf "redmine_${VERSION}_darwin_arm64.tar.gz"
sudo install -m 0755 "redmine_${VERSION}_darwin_arm64/redmine" /usr/local/bin/redmine
redmine --version

Agent Skill

This repository includes general-purpose agent instructions for working with Redmine through this CLI: skills/redmine-cli/SKILL.md.

The skill is not tied to a specific agent runtime. To use it, copy skills/redmine-cli/SKILL.md into your agent's skills, memories, or custom instructions mechanism.

If your agent supports skill folders, copy the whole skills/redmine-cli/ directory. Reload or restart the agent if its instructions are loaded only on startup. The skill assumes that the redmine executable is already installed and available in PATH.

Development

The command metadata and usage docs are generated from openapi/openapi.yaml.

make download-openapi-spec
make gen
make check

About

A Redmine CLI tool bringing Redmine to your command line

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors