rdm - Manage Redmine project wiki pages

rdm <subcommand> [options]

rdm is a shell script for managing wiki pages in a Redmine project. It allows users to create, list, update, and delete wiki pages, as well as upload attachments.

Specify the project to work on.

Specify the base url of the redmine instance.

Use the specified api-key to authenticate against your redmine server.

If the title parameter is specified as optional, fzf is called with a list of all pages to select one. If the optional title is prefix by t: or b: search for pages matching either the given title or body.

List Redmine wiki pages. If a query is given, filter the result through <grep -Ei>.

Delete the specified Redmine wiki page

Edit the content of the specified Redmine wiki page.

View the content of the specified Redmine wiki page in PAGER. If pager is not set <less -F --no-init> is used. The page is piped through pandoc to generate plain output. This can be changed by the formatter configuration option.

Write the raw content of the specified Redmine wiki page to stdout.

Attach FILES to the specified wiki page.

Search for QUERY in the title and body of all wiki pages in your project. If the parameter -t is given, search only titles.

Replace the content of the specified wiki page with stdin.

Append stdin to the content of the specified wiki page.

Prepend stdin to the content of the specified wiki page with stdin.

Open the specified wiki page with xdg-open. This will most likely open the page in your browser.

Yank the complete url to the specified wiki page to your clipboard.

Diff two versions of the specified wiki page. OLDER_VERSION defaults to -1 and NEWER_VERSION to the current version of the page. If OLDER_VERSION is negative it is substracted from NEWER_VERSION.

Open the rename dialog for the specified wiki page. As their's no api to rename a page, rdm has to use the browser.

Either <$XDG_CONFIG_HOME/rdm/rdmrc> or <~/.rdmrc> are sourced on startup as shell script.

For example:

pager="less -F \--no-init" formatter="pandoc -f textile -t plain" project="foo" base_url="https://redmine.example.com" api_key="0123456789abcdef" 

The following variables are used by rdm:

Sets the base url of your redmine instance.

Specify the project to work on.

Use the specified api key to authenticate again your redmine instance.

Sets the pager used by the view command.

Used by the view command to format the wiki page. It defaults to <pandoc -f textile -t plain>. If you don't wont view to format the page, you can get the raw content by setting formatter to <cat>.

Set editor. Default to the value of $EDITOR or "vi".

User to login with. Must be set if apikey is missing.

Password to login with. Must be set if apikey and pass_cmd is missing.

Command to query password. Must be set if apikey and password is missing.

Specify the project to work on.

Sets the base url of your redmine instance.

Use the specified api key to authenticate again your redmine instance.

Copyright 2024 Mario Domgörgen <mario@domgoergen.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.