Configuration

Run eecli init to create a .eecli.php config file in the current working directory.

Open .eecli.php and follow the instructions found in the file's comments to configure your EE setup.

You will receive a warning message if your system folder cannot be found automatically.

<?php

/**
 * Sample eecli Configuration file
 *
 * Rename this file to .eecli.php in your site root.
 */

// Quit if this is not being requested via the CLI
if (php_sapi_name() !== 'cli') {
    exit;
}

return array(
    /**
     * System path
     *
     * Specify the path to your EE system folder
     * If you leave this blank, it will assume your
     * folder is <current directory>/system
     */
    'system_path' => __DIR__.'/system',

    /**
     * Spoof $_SERVER variables
     *
     * This array will be merged with $_SERVER.
     *
     * When using php from the command line,
     * things like HTTP_HOST and DOCUMENT_ROOT
     * do not get set.
     *
     * Useful if you check for $_SERVER items
     * at runtime, like changing DB
     * credentials based on HTTP_HOST
     * in your config.php.
     *
     * You can also set these at the command line:
     *
     * eecli update:addons --http_host="site.dev"
     */
    'server' => array(
        'HTTP_HOST' => 'localhost',
        'DOCUMENT_ROOT' => __DIR__,
        'REQUEST_URI' => '/',
        'REMOTE_ADDR' => '127.0.0.1',
        'HTTP_USER_AGENT' => 'eecli',
    ),

    /**
     * Assign variables to config
     */
    'assign_to_config' => array(
        #'foo' => 'bar',
    ),

    /**
     * Custom commands
     *
     * An array of Command class names of
     * custom commands.
     */
    'commands' => array(
        #'\\Your\\Custom\\Command',
    ),

    /**
     * Custom command directories
     *
     * An array of directories, keyed by a namespace prefix,
     * which will be crawled for Command classes.
     */
    'commandDirs' => array(
        /*
        '\\Your\\Namespace' => '/path/to/commands',
        */
    ),

    /**
     * Event Callbacks
     *
     * An array of callback functions to be
     * invoked on the specified event.
     */
    'callbacks' => array(
        /*
        'bootstrap.before' => function ($app) {
        },
        'bootstrap.after' => function ($app) {
        },
        */
    ),

    /**
     * The default addon author name used when generating addons.
     */
    'addon_author_name' => '',

    /**
     * The default addon author URL used when generating addons.
     */
    'addon_author_url' => '',
);