= TracAdmin =
[[TracGuideToc]]

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.

The [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] plugin allows to perform some of those operations via a web interface.

== 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 a all the Wiki-related commands, run:
{{{
> help wiki
}}}

== Full Command Reference ==

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

----
See also: wiki:0.11/TracGuide, TracBackup, wiki:0.11/TracPermissions, TracEnvironment, wiki:0.11/TracIni, TracMigrate