blob: bdf6d86c1c61cf96b593c6986d9cffd1925bedf0 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<symfony>
<tasks>
<task id="help" namespace="_global" name="help">
<usage> help [--xml] [task_name]</usage>
<description>Displays help for a task</description>
<help>The &lt;em&gt;help&lt;/em&gt; task displays help for a given task:
&lt;em&gt;./symfony help test:all&lt;/em&gt;
You can also output the help as XML by using the &lt;strong&gt;--xml&lt;/strong&gt; option:
&lt;em&gt;./symfony help test:all --xml&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="task_name" is_required="0" is_array="0">
<description>The task name</description>
<defaults>
<default>help</default>
</defaults>
</argument>
</arguments>
<options>
<option name="--xml" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>To output help as XML</description>
</option>
</options>
</task>
<task id="list" namespace="_global" name="list">
<usage> list [--xml] [namespace]</usage>
<description>Lists tasks</description>
<help>The &lt;em&gt;list&lt;/em&gt; task lists all tasks:
&lt;em&gt;./symfony list&lt;/em&gt;
You can also display the tasks for a specific namespace:
&lt;em&gt;./symfony list test&lt;/em&gt;
You can also output the information as XML by using the &lt;strong&gt;--xml&lt;/strong&gt; option:
&lt;em&gt;./symfony list --xml&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="namespace" is_required="0" is_array="0">
<description>The namespace name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--xml" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>To output help as XML</description>
</option>
</options>
</task>
<task id="app:routes" namespace="app" name="routes">
<usage> app:routes application [name]</usage>
<description>Displays current routes for an application</description>
<help>The &lt;em&gt;app:routes&lt;/em&gt; displays the current routes for a given application:
&lt;em&gt;./symfony app:routes frontend&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="name" is_required="0" is_array="0">
<description>A route name</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="cache:clear" namespace="cache" name="clear">
<usage> cache:clear [--app[="..."]] [--env[="..."]] [--type[="..."]] </usage>
<description>Clears the cache</description>
<help>The &lt;em&gt;cache:clear&lt;/em&gt; task clears the symfony cache.
By default, it removes the cache for all available types, all applications,
and all environments.
You can restrict by type, application, or environment:
For example, to clear the &lt;strong&gt;frontend&lt;/strong&gt; application cache:
&lt;em&gt;./symfony cache:clear --app=frontend&lt;/em&gt;
To clear the cache for the &lt;strong&gt;prod&lt;/strong&gt; environment for the &lt;strong&gt;frontend&lt;/strong&gt; application:
&lt;em&gt;./symfony cache:clear --app=frontend --env=prod&lt;/em&gt;
To clear the cache for all &lt;strong&gt;prod&lt;/strong&gt; environments:
&lt;em&gt;./symfony cache:clear --env=prod&lt;/em&gt;
To clear the &lt;strong&gt;config&lt;/strong&gt; cache for all &lt;strong&gt;prod&lt;/strong&gt; environments:
&lt;em&gt;./symfony cache:clear --type=config --env=prod&lt;/em&gt;
The built-in types are: &lt;strong&gt;config&lt;/strong&gt;, &lt;strong&gt;i18n&lt;/strong&gt;, &lt;strong&gt;routing&lt;/strong&gt;, &lt;strong&gt;module&lt;/strong&gt;
and &lt;strong&gt;template&lt;/strong&gt;.
</help>
<aliases>
<alias>cc</alias>
</aliases>
<arguments/>
<options>
<option name="--app" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The application name</description>
<defaults/>
</option>
<option name="--env" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The environment</description>
<defaults/>
</option>
<option name="--type" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The type</description>
<defaults>
<default>all</default>
</defaults>
</option>
</options>
</task>
<task id="configure:author" namespace="configure" name="author">
<usage> configure:author author</usage>
<description>Configure project author</description>
<help>The &lt;em&gt;configure:author&lt;/em&gt; task configures the author for a project:
&lt;em&gt;./symfony configure:author "Fabien Potencier &lt;fabien.potencier@symfony-project.com&gt;"&lt;/em&gt;
The author is used by the generates to pre-configure the PHPDoc header for each generated file.
The value is stored in [config/properties.ini].</help>
<aliases/>
<arguments>
<argument name="author" is_required="1" is_array="0">
<description>The project author</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="generate:app" namespace="generate" name="app">
<usage> generate:app [--escaping-strategy="..."] [--csrf-secret="..."] app</usage>
<description>Generates a new application</description>
<help>The &lt;em&gt;generate:app&lt;/em&gt; task creates the basic directory structure
for a new application in the current project:
&lt;em&gt;./symfony generate:app frontend&lt;/em&gt;
This task also creates two front controller scripts in the
&lt;strong&gt;web/&lt;/strong&gt; directory:
&lt;em&gt;web/%application%.php&lt;/em&gt; for the production environment
&lt;em&gt;web/%application%_dev.php&lt;/em&gt; for the development environment
For the first application, the production environment script is named
&lt;strong&gt;index.php&lt;/strong&gt;.
If an application with the same name already exists,
it throws a &lt;strong&gt;sfCommandException&lt;/strong&gt;.
By default, the output escaping is enabled (to prevent XSS), and a random
secret is also generated to prevent CSRF.
You can disable output escaping by using the &lt;strong&gt;escaping-strategy&lt;/strong&gt;
option:
&lt;em&gt;./symfony generate:app frontend --escaping-strategy=false&lt;/em&gt;
You can enable session token in forms (to prevent CSRF) by defining
a secret with the &lt;strong&gt;csrf-secret&lt;/strong&gt; option:
&lt;em&gt;./symfony generate:app frontend --csrf-secret=UniqueSecret&lt;/em&gt;
You can customize the default skeleton used by the task by creating a
&lt;strong&gt;%sf_data_dir%/skeleton/app&lt;/strong&gt; directory.</help>
<aliases/>
<arguments>
<argument name="app" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--escaping-strategy" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>Output escaping strategy</description>
<defaults>
<default>1</default>
</defaults>
</option>
<option name="--csrf-secret" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>Secret to use for CSRF protection</description>
<defaults>
<default>1</default>
</defaults>
</option>
</options>
</task>
<task id="generate:module" namespace="generate" name="module">
<usage> generate:module application module</usage>
<description>Generates a new module</description>
<help>The &lt;em&gt;generate:module&lt;/em&gt; task creates the basic directory structure
for a new module in an existing application:
&lt;em&gt;./symfony generate:module frontend article&lt;/em&gt;
The task can also change the author name found in the &lt;strong&gt;actions.class.php&lt;/strong&gt;
if you have configure it in &lt;strong&gt;config/properties.ini&lt;/strong&gt;:
&lt;em&gt;[symfony]
name=blog
author=Fabien Potencier &lt;fabien.potencier@sensio.com&gt;&lt;/em&gt;
You can customize the default skeleton used by the task by creating a
&lt;strong&gt;%sf_data_dir%/skeleton/module&lt;/strong&gt; directory.
The task also creates a functional test stub named
&lt;strong&gt;%sf_test_dir%/functional/%application%/%module%ActionsTest.class.php&lt;/strong&gt;
that does not pass by default.
If a module with the same name already exists in the application,
it throws a &lt;strong&gt;sfCommandException&lt;/strong&gt;.</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="module" is_required="1" is_array="0">
<description>The module name</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="generate:project" namespace="generate" name="project">
<usage> generate:project [--orm="..."] [--installer="..."] name [author]</usage>
<description>Generates a new project</description>
<help>The &lt;em&gt;generate:project&lt;/em&gt; task creates the basic directory structure
for a new project in the current directory:
&lt;em&gt;./symfony generate:project blog&lt;/em&gt;
If the current directory already contains a symfony project,
it throws a &lt;strong&gt;sfCommandException&lt;/strong&gt;.
By default, the task configures Doctrine as the ORM. If you want to use
Propel, use the &lt;strong&gt;--orm&lt;/strong&gt; option:
&lt;em&gt;./symfony generate:project blog --orm=Propel&lt;/em&gt;
If you don't want to use an ORM, pass &lt;strong&gt;none&lt;/strong&gt; to &lt;strong&gt;--orm&lt;/strong&gt; option:
&lt;em&gt;./symfony generate:project blog --orm=none&lt;/em&gt;
You can also pass the &lt;strong&gt;--installer&lt;/strong&gt; option to further customize the
project:
&lt;em&gt;./symfony generate:project blog --installer=./installer.php&lt;/em&gt;
You can optionally include a second &lt;strong&gt;author&lt;/strong&gt; argument to specify what name to
use as author when symfony generates new classes:
&lt;em&gt;./symfony generate:project blog "Jack Doe"&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="name" is_required="1" is_array="0">
<description>The project name</description>
<defaults/>
</argument>
<argument name="author" is_required="0" is_array="0">
<description>The project author</description>
<defaults>
<default>Your name here</default>
</defaults>
</argument>
</arguments>
<options>
<option name="--orm" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The ORM to use by default</description>
<defaults>
<default>Doctrine</default>
</defaults>
</option>
<option name="--installer" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>An installer script to execute</description>
<defaults/>
</option>
</options>
</task>
<task id="generate:task" namespace="generate" name="task">
<usage> generate:task [--dir="..."] [--use-database="..."] [--brief-description="..."] task_name</usage>
<description>Creates a skeleton class for a new task</description>
<help>The &lt;em&gt;generate:task&lt;/em&gt; creates a new sfTask class based on the name passed as
argument:
&lt;em&gt;./symfony generate:task namespace:name&lt;/em&gt;
The &lt;strong&gt;namespaceNameTask.class.php&lt;/strong&gt; skeleton task is created under the &lt;strong&gt;lib/task/&lt;/strong&gt;
directory. Note that the namespace is optional.
If you want to create the file in another directory (relative to the project
root folder), pass it in the &lt;strong&gt;--dir&lt;/strong&gt; option. This directory will be created
if it does not already exist.
&lt;em&gt;./symfony generate:task namespace:name --dir=plugins/myPlugin/lib/task&lt;/em&gt;
If you want the task to default to a connection other than &lt;strong&gt;doctrine&lt;/strong&gt;, provide
the name of this connection with the &lt;strong&gt;--use-database&lt;/strong&gt; option:
&lt;em&gt;./symfony generate:task namespace:name --use-database=main&lt;/em&gt;
The &lt;strong&gt;--use-database&lt;/strong&gt; option can also be used to disable database
initialization in the generated task:
&lt;em&gt;./symfony generate:task namespace:name --use-database=false&lt;/em&gt;
You can also specify a description:
&lt;em&gt;./symfony generate:task namespace:name --brief-description="Does interesting things"&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="task_name" is_required="1" is_array="0">
<description>The task name (can contain namespace)</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--dir" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The directory to create the task in</description>
<defaults>
<default>lib/task</default>
</defaults>
</option>
<option name="--use-database" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>Whether the task needs model initialization to access database</description>
<defaults/>
</option>
<option name="--brief-description" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>A brief task description (appears in task list)</description>
<defaults/>
</option>
</options>
</task>
<task id="i18n:extract" namespace="i18n" name="extract">
<usage> i18n:extract [--display-new] [--display-old] [--auto-save] [--auto-delete] application culture</usage>
<description>Extracts i18n strings from php files</description>
<help>The &lt;em&gt;i18n:extract&lt;/em&gt; task extracts i18n strings from your project files
for the given application and target culture:
&lt;em&gt;./symfony i18n:extract frontend fr&lt;/em&gt;
By default, the task only displays the number of new and old strings
it found in the current project.
If you want to display the new strings, use the &lt;strong&gt;--display-new&lt;/strong&gt; option:
&lt;em&gt;./symfony i18n:extract --display-new frontend fr&lt;/em&gt;
To save them in the i18n message catalogue, use the &lt;strong&gt;--auto-save&lt;/strong&gt; option:
&lt;em&gt;./symfony i18n:extract --auto-save frontend fr&lt;/em&gt;
If you want to display strings that are present in the i18n messages
catalogue but are not found in the application, use the
&lt;strong&gt;--display-old&lt;/strong&gt; option:
&lt;em&gt;./symfony i18n:extract --display-old frontend fr&lt;/em&gt;
To automatically delete old strings, use the &lt;strong&gt;--auto-delete&lt;/strong&gt; but
be careful, especially if you have translations for plugins as they will
appear as old strings but they are not:
&lt;em&gt;./symfony i18n:extract --auto-delete frontend fr&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="culture" is_required="1" is_array="0">
<description>The target culture</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--display-new" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Output all new found strings</description>
</option>
<option name="--display-old" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Output all old strings</description>
</option>
<option name="--auto-save" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Save the new strings</description>
</option>
<option name="--auto-delete" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Delete old strings</description>
</option>
</options>
</task>
<task id="i18n:find" namespace="i18n" name="find">
<usage> i18n:find [--env="..."] application</usage>
<description>Finds non "i18n ready" strings in an application</description>
<help>The &lt;em&gt;i18n:find&lt;/em&gt; task finds non internationalized strings embedded in templates:
&lt;em&gt;./symfony i18n:find frontend&lt;/em&gt;
This task is able to find non internationalized strings in pure HTML and in PHP code:
&lt;p&gt;Non i18n text&lt;/p&gt;
&lt;p&gt;&lt;?php echo 'Test' ?&gt;&lt;/p&gt;
As the task returns all strings embedded in PHP, you can have some false positive (especially
if you use the string syntax for helper arguments).</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--env" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The environment</description>
<defaults>
<default>dev</default>
</defaults>
</option>
</options>
</task>
<task id="log:clear" namespace="log" name="clear">
<usage> log:clear </usage>
<description>Clears log files</description>
<help>The &lt;em&gt;log:clear&lt;/em&gt; task clears all symfony log files:
&lt;em&gt;./symfony log:clear&lt;/em&gt;</help>
<aliases/>
<arguments/>
<options/>
</task>
<task id="log:rotate" namespace="log" name="rotate">
<usage> log:rotate [--history="..."] [--period="..."] application env</usage>
<description>Rotates an application's log files</description>
<help>The &lt;em&gt;log:rotate&lt;/em&gt; task rotates application log files for a given
environment:
&lt;em&gt;./symfony log:rotate frontend dev&lt;/em&gt;
You can specify a &lt;strong&gt;period&lt;/strong&gt; or a &lt;strong&gt;history&lt;/strong&gt; option:
&lt;em&gt;./symfony log:rotate frontend dev --history=10 --period=7&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="env" is_required="1" is_array="0">
<description>The environment name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--history" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The maximum number of old log files to keep</description>
<defaults>
<default>10</default>
</defaults>
</option>
<option name="--period" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The period in days</description>
<defaults>
<default>7</default>
</defaults>
</option>
</options>
</task>
<task id="plugin:add-channel" namespace="plugin" name="add-channel">
<usage> plugin:add-channel name</usage>
<description>Add a new PEAR channel</description>
<help>The &lt;em&gt;plugin:add-channel&lt;/em&gt; task adds a new PEAR channel:
&lt;em&gt;./symfony plugin:add-channel symfony.plugins.pear.example.com&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="name" is_required="1" is_array="0">
<description>The channel name</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="plugin:install" namespace="plugin" name="install">
<usage> plugin:install [-s|--stability="..."] [-r|--release="..."] [-c|--channel="..."] [-d|--install_deps] [--force-license] name</usage>
<description>Installs a plugin</description>
<help>The &lt;em&gt;plugin:install&lt;/em&gt; task installs a plugin:
&lt;em&gt;./symfony plugin:install sfGuardPlugin&lt;/em&gt;
By default, it installs the latest &lt;strong&gt;stable&lt;/strong&gt; release.
If you want to install a plugin that is not stable yet,
use the &lt;strong&gt;stability&lt;/strong&gt; option:
&lt;em&gt;./symfony plugin:install --stability=beta sfGuardPlugin&lt;/em&gt;
&lt;em&gt;./symfony plugin:install -s beta sfGuardPlugin&lt;/em&gt;
You can also force the installation of a specific version:
&lt;em&gt;./symfony plugin:install --release=1.0.0 sfGuardPlugin&lt;/em&gt;
&lt;em&gt;./symfony plugin:install -r 1.0.0 sfGuardPlugin&lt;/em&gt;
To force installation of all required dependencies, use the &lt;em&gt;install_deps&lt;/em&gt; flag:
&lt;em&gt;./symfony plugin:install --install-deps sfGuardPlugin&lt;/em&gt;
&lt;em&gt;./symfony plugin:install -d sfGuardPlugin&lt;/em&gt;
By default, the PEAR channel used is &lt;em&gt;symfony-plugins&lt;/em&gt;
(plugins.symfony-project.org).
You can specify another channel with the &lt;strong&gt;channel&lt;/strong&gt; option:
&lt;em&gt;./symfony plugin:install --channel=mypearchannel sfGuardPlugin&lt;/em&gt;
&lt;em&gt;./symfony plugin:install -c mypearchannel sfGuardPlugin&lt;/em&gt;
You can also install PEAR packages hosted on a website:
&lt;em&gt;./symfony plugin:install http://somewhere.example.com/sfGuardPlugin-1.0.0.tgz&lt;/em&gt;
Or local PEAR packages:
&lt;em&gt;./symfony plugin:install /home/fabien/plugins/sfGuardPlugin-1.0.0.tgz&lt;/em&gt;
If the plugin contains some web content (images, stylesheets or javascripts),
the task creates a &lt;strong&gt;%name%&lt;/strong&gt; symbolic link for those assets under &lt;strong&gt;web/&lt;/strong&gt;.
On Windows, the task copy all the files to the &lt;strong&gt;web/%name%&lt;/strong&gt; directory.</help>
<aliases/>
<arguments>
<argument name="name" is_required="1" is_array="0">
<description>The plugin name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--stability" shortcut="-s" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The preferred stability (stable, beta, alpha)</description>
<defaults/>
</option>
<option name="--release" shortcut="-r" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The preferred version</description>
<defaults/>
</option>
<option name="--channel" shortcut="-c" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The PEAR channel name</description>
<defaults/>
</option>
<option name="--install_deps" shortcut="-d" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Whether to force installation of required dependencies</description>
</option>
<option name="--force-license" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Whether to force installation even if the license is not MIT like</description>
</option>
</options>
</task>
<task id="plugin:list" namespace="plugin" name="list">
<usage> plugin:list </usage>
<description>Lists installed plugins</description>
<help>The &lt;em&gt;plugin:list&lt;/em&gt; task lists all installed plugins:
&lt;em&gt;./symfony plugin:list&lt;/em&gt;
It also gives the channel and version for each plugin.</help>
<aliases/>
<arguments/>
<options/>
</task>
<task id="plugin:publish-assets" namespace="plugin" name="publish-assets">
<usage> plugin:publish-assets [--core-only] [plugins1] ... [pluginsN]</usage>
<description>Publishes web assets for all plugins</description>
<help>The &lt;em&gt;plugin:publish-assets&lt;/em&gt; task will publish web assets from all plugins.
&lt;em&gt;./symfony plugin:publish-assets&lt;/em&gt;
In fact this will send the &lt;em&gt;plugin.post_install&lt;/em&gt; event to each plugin.
You can specify which plugin or plugins should install their assets by passing
those plugins' names as arguments:
&lt;em&gt;./symfony plugin:publish-assets sfDoctrinePlugin&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="plugins" is_required="0" is_array="1">
<description>Publish this plugin's assets</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--core-only" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>If set only core plugins will publish their assets</description>
</option>
</options>
</task>
<task id="plugin:uninstall" namespace="plugin" name="uninstall">
<usage> plugin:uninstall [-c|--channel="..."] [-d|--install_deps] name</usage>
<description>Uninstalls a plugin</description>
<help>The &lt;em&gt;plugin:uninstall&lt;/em&gt; task uninstalls a plugin:
&lt;em&gt;./symfony plugin:uninstall sfGuardPlugin&lt;/em&gt;
The default channel is &lt;em&gt;symfony&lt;/em&gt;.
You can also uninstall a plugin which has a different channel:
&lt;em&gt;./symfony plugin:uninstall --channel=mypearchannel sfGuardPlugin&lt;/em&gt;
&lt;em&gt;./symfony plugin:uninstall -c mypearchannel sfGuardPlugin&lt;/em&gt;
Or you can use the &lt;em&gt;channel/package&lt;/em&gt; notation:
&lt;em&gt;./symfony plugin:uninstall mypearchannel/sfGuardPlugin&lt;/em&gt;
You can get the PEAR channel name of a plugin by launching the
&lt;strong&gt;plugin:list] task.
If the plugin contains some web content (images, stylesheets or javascripts),
the task also removes the [web/%name%&lt;/strong&gt; symbolic link (on *nix)
or directory (on Windows).</help>
<aliases/>
<arguments>
<argument name="name" is_required="1" is_array="0">
<description>The plugin name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--channel" shortcut="-c" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The PEAR channel name</description>
<defaults/>
</option>
<option name="--install_deps" shortcut="-d" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Whether to force installation of dependencies</description>
</option>
</options>
</task>
<task id="plugin:upgrade" namespace="plugin" name="upgrade">
<usage> plugin:upgrade [-s|--stability="..."] [-r|--release="..."] [-c|--channel="..."] name</usage>
<description>Upgrades a plugin</description>
<help>The &lt;em&gt;plugin:upgrade&lt;/em&gt; task tries to upgrade a plugin:
&lt;em&gt;./symfony plugin:upgrade sfGuardPlugin&lt;/em&gt;
The default channel is &lt;em&gt;symfony&lt;/em&gt;.
If the plugin contains some web content (images, stylesheets or javascripts),
the task also updates the &lt;strong&gt;web/%name%&lt;/strong&gt; directory content on Windows.
See &lt;em&gt;plugin:install&lt;/em&gt; for more information about the format of the plugin name and options.</help>
<aliases/>
<arguments>
<argument name="name" is_required="1" is_array="0">
<description>The plugin name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--stability" shortcut="-s" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The preferred stability (stable, beta, alpha)</description>
<defaults/>
</option>
<option name="--release" shortcut="-r" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The preferred version</description>
<defaults/>
</option>
<option name="--channel" shortcut="-c" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The PEAR channel name</description>
<defaults/>
</option>
</options>
</task>
<task id="project:clear-controllers" namespace="project" name="clear-controllers">
<usage> project:clear-controllers </usage>
<description>Clears all non production environment controllers</description>
<help>The &lt;em&gt;project:clear-controllers&lt;/em&gt; task clears all non production environment
controllers:
&lt;em&gt;./symfony project:clear-controllers&lt;/em&gt;
You can use this task on a production server to remove all front
controller scripts except the production ones.
If you have two applications named &lt;strong&gt;frontend&lt;/strong&gt; and &lt;strong&gt;backend&lt;/strong&gt;,
you have four default controller scripts in &lt;strong&gt;web/&lt;/strong&gt;:
&lt;em&gt;index.php
frontend_dev.php
backend.php
backend_dev.php&lt;/em&gt;
After executing the &lt;strong&gt;project:clear-controllers&lt;/strong&gt; task, two front
controller scripts are left in &lt;strong&gt;web/&lt;/strong&gt;:
&lt;em&gt;index.php
backend.php&lt;/em&gt;
Those two controllers are safe because debug mode and the web debug
toolbar are disabled.</help>
<aliases/>
<arguments/>
<options/>
</task>
<task id="project:deploy" namespace="project" name="deploy">
<usage> project:deploy [--go] [--rsync-dir="..."] [--rsync-options[="..."]] server</usage>
<description>Deploys a project to another server</description>
<help>The &lt;em&gt;project:deploy&lt;/em&gt; task deploys a project on a server:
&lt;em&gt;./symfony project:deploy production&lt;/em&gt;
The server must be configured in &lt;strong&gt;config/properties.ini&lt;/strong&gt;:
&lt;em&gt;[production]
host=www.example.com
port=22
user=fabien
dir=/var/www/sfblog/
type=rsync&lt;/em&gt;
To automate the deployment, the task uses rsync over SSH.
You must configure SSH access with a key or configure the password
in &lt;strong&gt;config/properties.ini&lt;/strong&gt;.
By default, the task is in dry-mode. To do a real deployment, you
must pass the &lt;strong&gt;--go&lt;/strong&gt; option:
&lt;em&gt;./symfony project:deploy --go production&lt;/em&gt;
Files and directories configured in &lt;strong&gt;config/rsync_exclude.txt&lt;/strong&gt; are
not deployed:
&lt;em&gt;.svn
/web/uploads/*
/cache/*
/log/*&lt;/em&gt;
You can also create a &lt;strong&gt;rsync.txt&lt;/strong&gt; and &lt;strong&gt;rsync_include.txt&lt;/strong&gt; files.
If you need to customize the &lt;strong&gt;rsync*.txt&lt;/strong&gt; files based on the server,
you can pass a &lt;strong&gt;rsync-dir&lt;/strong&gt; option:
&lt;em&gt;./symfony project:deploy --go --rsync-dir=config/production production&lt;/em&gt;
Last, you can specify the options passed to the rsync executable, using the
&lt;em&gt;rsync-options&lt;/em&gt; option (defaults are &lt;em&gt;-azC --force --delete --progress&lt;/em&gt;):
&lt;em&gt;./symfony project:deploy --go --rsync-options=-avz&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="server" is_required="1" is_array="0">
<description>The server name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--go" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Do the deployment</description>
</option>
<option name="--rsync-dir" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The directory where to look for rsync*.txt files</description>
<defaults>
<default>config</default>
</defaults>
</option>
<option name="--rsync-options" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>To options to pass to the rsync executable</description>
<defaults>
<default>-azC --force --delete --progress</default>
</defaults>
</option>
</options>
</task>
<task id="project:disable" namespace="project" name="disable">
<usage> project:disable env [app1] ... [appN]</usage>
<description>Disables an application in a given environment</description>
<help>The &lt;em&gt;project:disable&lt;/em&gt; task disables an environment:
&lt;em&gt;./symfony project:disable prod&lt;/em&gt;
You can also specify individual applications to be disabled in that
environment:
&lt;em&gt;./symfony project:disable prod frontend backend&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="env" is_required="1" is_array="0">
<description>The environment name</description>
<defaults/>
</argument>
<argument name="app" is_required="0" is_array="1">
<description>The application name</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="project:enable" namespace="project" name="enable">
<usage> project:enable env [app1] ... [appN]</usage>
<description>Enables an application in a given environment</description>
<help>The &lt;em&gt;project:enable&lt;/em&gt; task enables a specific environment:
&lt;em&gt;./symfony project:enable frontend prod&lt;/em&gt;
You can also specify individual applications to be enabled in that
environment:
&lt;em&gt;./symfony project:enable prod frontend backend&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="env" is_required="1" is_array="0">
<description>The environment name</description>
<defaults/>
</argument>
<argument name="app" is_required="0" is_array="1">
<description>The application name</description>
<defaults/>
</argument>
</arguments>
<options/>
</task>
<task id="project:optimize" namespace="project" name="optimize">
<usage> project:optimize application [env]</usage>
<description>Optimizes a project for better performance</description>
<help>The &lt;em&gt;project:optimize&lt;/em&gt; optimizes a project for better performance:
&lt;em&gt;./symfony project:optimize frontend prod&lt;/em&gt;
This task should only be used on a production server. Don't forget to re-run
the task each time the project changes.</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="env" is_required="0" is_array="0">
<description>The environment name</description>
<defaults>
<default>prod</default>
</defaults>
</argument>
</arguments>
<options/>
</task>
<task id="project:permissions" namespace="project" name="permissions">
<usage> project:permissions </usage>
<description>Fixes symfony directory permissions</description>
<help>The &lt;em&gt;project:permissions&lt;/em&gt; task fixes directory permissions:
&lt;em&gt;./symfony project:permissions&lt;/em&gt;</help>
<aliases/>
<arguments/>
<options/>
</task>
<task id="project:send-emails" namespace="project" name="send-emails">
<usage> project:send-emails [--application[="..."]] [--env="..."] [--message-limit[="..."]] [--time-limit[="..."]] </usage>
<description>Sends emails stored in a queue</description>
<help>The &lt;em&gt;project:send-emails&lt;/em&gt; sends emails stored in a queue:
&lt;em&gt;php symfony project:send-emails&lt;/em&gt;
You can limit the number of messages to send:
&lt;em&gt;php symfony project:send-emails --message-limit=10&lt;/em&gt;
Or limit to time (in seconds):
&lt;em&gt;php symfony project:send-emails --time-limit=10&lt;/em&gt;</help>
<aliases/>
<arguments/>
<options>
<option name="--application" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The application name</description>
<defaults>
<default>1</default>
</defaults>
</option>
<option name="--env" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The environment</description>
<defaults>
<default>dev</default>
</defaults>
</option>
<option name="--message-limit" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The maximum number of messages to send</description>
<defaults/>
</option>
<option name="--time-limit" shortcut="" accept_parameter="1" is_parameter_required="0" is_multiple="0">
<description>The time limit for sending messages (in seconds)</description>
<defaults/>
</option>
</options>
</task>
<task id="project:validate" namespace="project" name="validate">
<usage> project:validate </usage>
<description>Finds deprecated usage in a project</description>
<help>The &lt;em&gt;project:validate&lt;/em&gt; task detects deprecated usage in your project.
&lt;em&gt;./symfony project:validate&lt;/em&gt;
The task lists all the files you need to change before switching to
symfony 1.4.</help>
<aliases/>
<arguments/>
<options/>
</task>
<task id="symfony:test" namespace="symfony" name="test">
<usage> symfony:test [-u|--update-autoloader] [-f|--only-failed] [--xml="..."] [--rebuild-all] </usage>
<description>Launches the symfony test suite</description>
<help>The &lt;em&gt;test:all&lt;/em&gt; task launches the symfony test suite:
&lt;em&gt;./symfony symfony:test&lt;/em&gt;</help>
<aliases/>
<arguments/>
<options>
<option name="--update-autoloader" shortcut="-u" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Update the sfCoreAutoload class</description>
</option>
<option name="--only-failed" shortcut="-f" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Only run tests that failed last time</description>
</option>
<option name="--xml" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The file name for the JUnit compatible XML log file</description>
<defaults/>
</option>
<option name="--rebuild-all" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Rebuild all generated fixture files</description>
</option>
</options>
</task>
<task id="test:all" namespace="test" name="all">
<usage> test:all [-f|--only-failed] [--xml="..."] </usage>
<description>Launches all tests</description>
<help>The &lt;em&gt;test:all&lt;/em&gt; task launches all unit and functional tests:
&lt;em&gt;./symfony test:all&lt;/em&gt;
The task launches all tests found in &lt;strong&gt;test/&lt;/strong&gt;.
If some tests fail, you can use the &lt;strong&gt;--trace&lt;/strong&gt; option to have more
information about the failures:
&lt;em&gt;./symfony test:all -t&lt;/em&gt;
Or you can also try to fix the problem by launching them by hand or with the
&lt;strong&gt;test:unit&lt;/strong&gt; and &lt;strong&gt;test:functional&lt;/strong&gt; task.
Use the &lt;strong&gt;--only-failed&lt;/strong&gt; option to force the task to only execute tests
that failed during the previous run:
&lt;em&gt;./symfony test:all --only-failed&lt;/em&gt;
Here is how it works: the first time, all tests are run as usual. But for
subsequent test runs, only tests that failed last time are executed. As you
fix your code, some tests will pass, and will be removed from subsequent runs.
When all tests pass again, the full test suite is run... you can then rinse
and repeat.
The task can output a JUnit compatible XML log file with the &lt;strong&gt;--xml&lt;/strong&gt;
options:
&lt;em&gt;./symfony test:all --xml=log.xml&lt;/em&gt;</help>
<aliases/>
<arguments/>
<options>
<option name="--only-failed" shortcut="-f" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Only run tests that failed last time</description>
</option>
<option name="--xml" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The file name for the JUnit compatible XML log file</description>
<defaults/>
</option>
</options>
</task>
<task id="test:coverage" namespace="test" name="coverage">
<usage> test:coverage [--detailed] test_name lib_name</usage>
<description>Outputs test code coverage</description>
<help>The &lt;em&gt;test:coverage&lt;/em&gt; task outputs the code coverage
given a test file or test directory
and a lib file or lib directory for which you want code
coverage:
&lt;em&gt;./symfony test:coverage test/unit/model lib/model&lt;/em&gt;
To output the lines not covered, pass the &lt;em&gt;--detailed&lt;/em&gt; option:
&lt;em&gt;./symfony test:coverage --detailed test/unit/model lib/model&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="test_name" is_required="1" is_array="0">
<description>A test file name or a test directory</description>
<defaults/>
</argument>
<argument name="lib_name" is_required="1" is_array="0">
<description>A lib file name or a lib directory for wich you want to know the coverage</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--detailed" shortcut="" accept_parameter="0" is_parameter_required="0" is_multiple="0">
<description>Output detailed information</description>
</option>
</options>
</task>
<task id="test:functional" namespace="test" name="functional">
<usage> test:functional [--xml="..."] application [controller1] ... [controllerN]</usage>
<description>Launches functional tests</description>
<help>The &lt;em&gt;test:functional&lt;/em&gt; task launches functional tests for a
given application:
&lt;em&gt;./symfony test:functional frontend&lt;/em&gt;
The task launches all tests found in &lt;strong&gt;test/functional/%application%&lt;/strong&gt;.
If some tests fail, you can use the &lt;strong&gt;--trace&lt;/strong&gt; option to have more
information about the failures:
&lt;em&gt;./symfony test:functional frontend -t&lt;/em&gt;
You can launch all functional tests for a specific controller by
giving a controller name:
&lt;em&gt;./symfony test:functional frontend article&lt;/em&gt;
You can also launch all functional tests for several controllers:
&lt;em&gt;./symfony test:functional frontend article comment&lt;/em&gt;
The task can output a JUnit compatible XML log file with the &lt;strong&gt;--xml&lt;/strong&gt;
options:
&lt;em&gt;./symfony test:functional --xml=log.xml&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="application" is_required="1" is_array="0">
<description>The application name</description>
<defaults/>
</argument>
<argument name="controller" is_required="0" is_array="1">
<description>The controller name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--xml" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The file name for the JUnit compatible XML log file</description>
<defaults/>
</option>
</options>
</task>
<task id="test:unit" namespace="test" name="unit">
<usage> test:unit [--xml="..."] [name1] ... [nameN]</usage>
<description>Launches unit tests</description>
<help>The &lt;em&gt;test:unit&lt;/em&gt; task launches unit tests:
&lt;em&gt;./symfony test:unit&lt;/em&gt;
The task launches all tests found in &lt;strong&gt;test/unit&lt;/strong&gt;.
If some tests fail, you can use the &lt;strong&gt;--trace&lt;/strong&gt; option to have more
information about the failures:
&lt;em&gt;./symfony test:unit -t&lt;/em&gt;
You can launch unit tests for a specific name:
&lt;em&gt;./symfony test:unit strtolower&lt;/em&gt;
You can also launch unit tests for several names:
&lt;em&gt;./symfony test:unit strtolower strtoupper&lt;/em&gt;
The task can output a JUnit compatible XML log file with the &lt;strong&gt;--xml&lt;/strong&gt;
options:
&lt;em&gt;./symfony test:unit --xml=log.xml&lt;/em&gt;</help>
<aliases/>
<arguments>
<argument name="name" is_required="0" is_array="1">
<description>The test name</description>
<defaults/>
</argument>
</arguments>
<options>
<option name="--xml" shortcut="" accept_parameter="1" is_parameter_required="1" is_multiple="0">
<description>The file name for the JUnit compatible XML log file</description>
<defaults/>
</option>
</options>
</task>
</tasks>
<namespaces>
<namespace id="_global">
<task>help</task>
<task>list</task>
</namespace>
<namespace id="app">
<task>routes</task>
</namespace>
<namespace id="cache">
<task>clear</task>
</namespace>
<namespace id="configure">
<task>author</task>
</namespace>
<namespace id="generate">
<task>app</task>
<task>module</task>
<task>project</task>
<task>task</task>
</namespace>
<namespace id="i18n">
<task>extract</task>
<task>find</task>
</namespace>
<namespace id="log">
<task>clear</task>
<task>rotate</task>
</namespace>
<namespace id="plugin">
<task>add-channel</task>
<task>install</task>
<task>list</task>
<task>publish-assets</task>
<task>uninstall</task>
<task>upgrade</task>
</namespace>
<namespace id="project">
<task>clear-controllers</task>
<task>deploy</task>
<task>disable</task>
<task>enable</task>
<task>optimize</task>
<task>permissions</task>
<task>send-emails</task>
<task>validate</task>
</namespace>
<namespace id="symfony">
<task>test</task>
</namespace>
<namespace id="test">
<task>all</task>
<task>coverage</task>
<task>functional</task>
<task>unit</task>
</namespace>
</namespaces>
</symfony>