TracAdmin

Trac is distributed with a powerful command-line configuration tool. This tool can be used to configure and customize your Trac-installation to better fit your needs.

Some of those operations can also be performed via the Admin web interface, an updated version of the WebAdmin plugin now integrated within Trac (since version 0.11).

Usage

You can get a comprehensive list of the available options, commands and sub-commands by invoking trac-admin with the help command:.

trac-admin help

Unless you’re executing the help, about or version sub-commands, you’ll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example:

trac-admin /path/to/projenv wiki list

Interactive Mode

When passing the environment path as the only argument, trac-admin starts in interactive mode. Commands can then be executed on the selected environment using the prompt, which offers tab-completion (on non-Windows environments, and when the Python readline module is available) and automatic repetition of the last command issued.

Once you’re in interactive mode, you can also get help on specific commands or subsets of commands:

For example, to get an explanation of the resync command, run:

> help resync

To get help on all the Wiki-related commands, run:

> help wiki

Full Command Reference

help
	-- Show documentation
initenv
	-- Create and initialize a new environment interactively
initenv https://emelfm2.net/files/wiki/<projectname> https://emelfm2.net/files/wiki/<db> https://emelfm2.net/files/wiki/<repostype> https://emelfm2.net/files/wiki/<repospath>
	-- Create and initialize a new environment from arguments
hotcopy https://emelfm2.net/files/wiki/<backupdir>
	-- Make a hot backup copy of an environment
resync
	-- Re-synchronize trac with the repository
resync https://emelfm2.net/files/wiki/<rev>
	-- Re-synchronize only the given https://emelfm2.net/files/wiki/<rev>
upgrade
	-- Upgrade database to current version
deploy https://emelfm2.net/files/wiki/<directory>
	-- Extract static resources from Trac and all plugins.
permission list [user]
	-- List permission rules
permission add https://emelfm2.net/files/wiki/<user> https://emelfm2.net/files/wiki/<action> [action] [...]
	-- Add a new permission rule
permission remove https://emelfm2.net/files/wiki/<user> https://emelfm2.net/files/wiki/<action> [action] [...]
	-- Remove permission rule
wiki list
	-- List wiki pages
wiki remove https://emelfm2.net/files/wiki/<page>
	-- Remove wiki page
wiki export https://emelfm2.net/files/wiki/<page> [file]
	-- Export wiki page to file or stdout
wiki import https://emelfm2.net/files/wiki/<page> [file]
	-- Import wiki page from file or stdin
wiki dump https://emelfm2.net/files/wiki/<directory>
	-- Export all wiki pages to files named by title
wiki load https://emelfm2.net/files/wiki/<directory>
	-- Import all wiki pages from directory
wiki upgrade
	-- Upgrade default wiki pages to current version
ticket remove https://emelfm2.net/files/wiki/<number>
	-- Remove ticket
ticket_type list
	-- Show possible ticket types
ticket_type add https://emelfm2.net/files/wiki/<value>
	-- Add a ticket type
ticket_type change https://emelfm2.net/files/wiki/<value> https://emelfm2.net/files/wiki/<newvalue>
	-- Change a ticket type
ticket_type remove https://emelfm2.net/files/wiki/<value>
	-- Remove a ticket type
ticket_type order https://emelfm2.net/files/wiki/<value> up|down
	-- Move a ticket type up or down in the list
priority list
	-- Show possible ticket priorities
priority add https://emelfm2.net/files/wiki/<value>
	-- Add a priority value option
priority change https://emelfm2.net/files/wiki/<value> https://emelfm2.net/files/wiki/<newvalue>
	-- Change a priority value
priority remove https://emelfm2.net/files/wiki/<value>
	-- Remove priority value
priority order https://emelfm2.net/files/wiki/<value> up|down
	-- Move a priority value up or down in the list
severity list
	-- Show possible ticket severities
severity add https://emelfm2.net/files/wiki/<value>
	-- Add a severity value option
severity change https://emelfm2.net/files/wiki/<value> https://emelfm2.net/files/wiki/<newvalue>
	-- Change a severity value
severity remove https://emelfm2.net/files/wiki/<value>
	-- Remove severity value
severity order https://emelfm2.net/files/wiki/<value> up|down
	-- Move a severity value up or down in the list
component list
	-- Show available components
component add https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<owner>
	-- Add a new component
component rename https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<newname>
	-- Rename a component
component remove https://emelfm2.net/files/wiki/<name>
	-- Remove/uninstall component
component chown https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<owner>
	-- Change component ownership
version list
	-- Show versions
version add https://emelfm2.net/files/wiki/<name> [time]
	-- Add version
version rename https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<newname>
	-- Rename version
version time https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<time>
	-- Set version date (Format: "YYYY-MM-DD", "now" or "")
version remove https://emelfm2.net/files/wiki/<name>
	-- Remove version
milestone list
	-- Show milestones
milestone add https://emelfm2.net/files/wiki/<name> [due]
	-- Add milestone
milestone rename https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<newname>
	-- Rename milestone
milestone due https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<due>
	-- Set milestone due date (Format: "YYYY-MM-DD", "now" or "")
milestone completed https://emelfm2.net/files/wiki/<name> https://emelfm2.net/files/wiki/<completed>
	-- Set milestone completed date (Format: "YYYY-MM-DD", "now" or "")
milestone remove https://emelfm2.net/files/wiki/<name>
	-- Remove milestone
resolution list
	-- Show possible ticket resolutions
resolution add https://emelfm2.net/files/wiki/<value>
	-- Add a resolution value option
resolution change https://emelfm2.net/files/wiki/<value> https://emelfm2.net/files/wiki/<newvalue>
	-- Change a resolution value
resolution remove https://emelfm2.net/files/wiki/<value>
	-- Remove resolution value
resolution order https://emelfm2.net/files/wiki/<value> up|down
	-- Move a resolution value up or down in the list

Notes

The initenv also supports an extra --inherit option, which can be used to specify the [inherit] file option at environment creation time so that only the options not already specified in the global configuration file will be written in the conf/trac.ini file of the newly created environment. See TracIni#GlobalConfiguration.

---

See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, TracMigrate?