Skip to content

Wiki

The wiki command (alias w) reads and writes pages on a project’s wiki.

Every subcommand needs a project. Pass --project <identifier>, or rely on the default project of the active profile (see auth).

Terminal window
redmine wiki list [flags]

Aliases: ls. Lists each page’s title and last-modified timestamp. Results are paginated server-side; combine --limit 0 with --offset to walk large wikis.

FlagDescription
--projectProject identifier or numeric ID. Falls back to the default project of the active profile.
--limitMaximum number of results (0 for all)
--offsetResult offset for pagination
-o, --outputOutput format: table, json, csv
Terminal window
redmine wiki list --project myproject
Terminal window
redmine wiki get <page> [flags]

Aliases: show, view. Prints the page metadata and full Textile/Markdown source. Pass --version to fetch a historical revision instead of the current one.

FlagDescription
--projectProject identifier or numeric ID
--versionPage version to fetch (omit or 0 for the latest)
--includeInclude related data. Only attachments is supported.
-o, --outputOutput format
Terminal window
redmine wiki get WikiStart --project myproject
redmine wiki get WikiStart --project myproject --version 3
redmine wiki get WikiStart --project myproject --include attachments
Terminal window
redmine wiki create <page> [flags]

Aliases: new. Creates a new wiki page. If a page with the same name already exists, Redmine overwrites it. Use update when you want to be sure you are editing rather than replacing.

FlagDescription
--projectProject identifier or numeric ID
-t, --textPage content in Textile/Markdown. required
--titleDisplay title (defaults to the page name)
--commentsChange comment recorded in the page history
--attachPath to a file to attach (repeatable)
-o, --outputOutput format
Terminal window
redmine wiki create MyPage --project myproject --text "h1. Hello World"
redmine wiki create MyPage --project myproject \
--text "Content here" --title "My Page" --comments "Initial draft"
redmine wiki create MyPage --project myproject \
--text "See diagram" --attach ./diagram.png
Terminal window
redmine wiki update <page> [flags]

Aliases: edit. Edits an existing page. Only the fields you pass change. When --text is omitted, the current page text is fetched and resent unchanged so that retitling or re-commenting does not wipe content.

FlagDescription
--projectProject identifier or numeric ID
-t, --textNew page content. If omitted, the current text is preserved.
--titleNew display title
--commentsChange comment recorded in the page history
--attachPath to a file to attach (repeatable)
Terminal window
redmine wiki update MyPage --project myproject --text "Updated content"
redmine wiki update MyPage --project myproject --comments "Fixed typo"
redmine wiki update MyPage --project myproject --title "New Title"
redmine wiki update MyPage --project myproject --attach ./screenshot.png
destructive
Terminal window
redmine wiki delete <page> [flags]

Aliases: rm. Permanently removes the page along with all its attachments and version history. Child pages are re-parented to the wiki root rather than deleted.

FlagDescription
--projectProject identifier or numeric ID
-f, --forceSkip the confirmation prompt
Terminal window
redmine wiki delete MyPage --project myproject
redmine wiki delete MyPage --project myproject --force