repo_zf1/documentation/manual/en/module_specs/Zend_Tool_Framework-CliTool.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.tool.framework.clitool">
    <title>Using the CLI Tool</title>

    <para>
        The CLI, or command line tool (internally known as the console tool), is
        currently the primary interface for dispatching <code>Zend_Tool</code>
        requests. With the CLI tool, developers can issue tooling requests
        inside a the "command line windows", also commonly known as a "terminal"
        window. This environment is predominant in the *nix environment, but
        also has a common implementation in windows with the
        <code>cmd.exe</code>, console2 and also with the Cygwin project.
    </para>

    <sect2 id="zend.tool.framework.clitool.setup-general">
        <title>Setting up the CLI tool</title>

        <para>
            To issue tooling requests via the command line client, you first
            need to setup the client so that your system can handle the "zf"
            command. The command line client, for all intents and purposes, is
            the <code>.sh</code> or <code>.bat</code> file that is provided with
            your Zend Framework distribution. In trunk, it can be found here:
            <ulink url="http://framework.zend.com/svn/framework/standard/trunk/bin/">http://framework.zend.com/svn/framework/standard/trunk/bin/</ulink>
        </para>

        <para>
            As you can see, there are 3 files in the <code>bin/</code>
            directory: a <code>zf.php</code>, <code>zf.sh</code>, and
            <code>zf.bat</code>. The <code>zf.sh</code> and the
            <code>zf.bat</code> are the operating system specific client
            wrappers: <code>zf.sh</code> for the *nix environment, and zf.bat
            for the Win32 environment. These client wrappers are responsible
            for finding the proper <code>php.exe</code>, finding the
            <code>zf.php</code>, and passing on the client request. The
            <code>zf.php</code> is the responsible for handling understanding
            your environment, constructing the proper include_path, and passing
            what is provided on the command line to the proper library component
            for dispatching.
        </para>

        <para>
            Ultimately, you want to ensure two things to make everything work
            regardless of the operating system you are on:
        </para>

        <orderedlist>
            <listitem>
                <para>
                    <code>zf.sh/zf.bat</code> is reachable from your system
                    path. This is the ability to call <code>zf</code> from
                    anywhere on your command line, regardless of what your
                    current working directory is.
                </para>
            </listitem>
            <listitem>
                <para>
                    ZendFramework/library is in your <code>include_path</code>.
                </para>
            </listitem>
        </orderedlist>

        <para>
            <emphasis>Note:</emphasis> while the above are the most ideal
            requirements, you can simply download Zend Framework and expect it
            to work as <code>./path/to/zf.php</code> some command.
        </para>

    </sect2>

    <sect2 id="zend.tool.framework.clitool.setup-starnix">
        <title>Setting up the CLI tool on Unix-like Systems</title>

        <para>
            The most common setup in the *nix environment, is to copy the
            <code>zf.sh</code> and <code>zf.php</code> into the same directory
            as your PHP binary. This can generally be found in one of the
            following places:
        </para>

        <programlisting language="text"><![CDATA[
/usr/bin
/usr/local/bin
/usr/local/ZendServer/bin/
/Applications/ZendServer/bin/
]]></programlisting>

        <para>
            To find out the location of your PHP binary, you can execute 'which
            php' on the command line. This will return the location of the php
            binary you will be using to run php scripts in this environment.
        </para>

        <para>
            The next order of business is to ensure that the Zend Framework
            library is setup correctly inside of the system PHP
            <code>include_path</code>. To find out where your
            <code>include_path</code> is located, you can execute 'php -i' and
            look for the <code>include_path</code> variable, or more succinctly,
            execute 'php -i | grep include_path'. Once you have found where
            your <code>include_path</code> is located (this will generally be
            something like /usr/lib/php, /usr/share/php, /usr/local/lib/php, or
            similar), ensure that the contents of the library/ directory are put
            inside your <code>include_path</code> specified directory.
        </para>

        <para>
            Once you have done those two things, you should be able to issue a
            command and get back the proper response like this:
        </para>

        <para>
            <inlinegraphic scale="100" align="center" valign="middle"
                fileref="figures/zend.tool.framework.cliversionunix.png" format="PNG" />
        </para>

        <para>
            If you do not see this type of output, go back and check your setup
            to ensure you have all of the necessary peices in the proper place.
        </para>

        <para>
            There are a couple of alternative setups you might want to employ
            depending on your servers configuration, your level of access, or
            for other reasons.
        </para>

        <para>
            <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
            Framework download together as is, and creating a link from a PATH
            location to the <code>zf.sh</code>. What this means is you can
            place the contents of the ZendFramework download into a location
            such as <code>/usr/local/share/ZendFramework</code>, or more locally
            like <code>/home/username/lib/ZendFramework</code>, and creating a
            symbolic link to the <code>zf.sh</code>.
        </para>

        <para>
            Assuming you want to put the link inside <code>/usr/local/bin</code>
            (this could also work for placing the link inside
            <code>/home/username/bin/</code> for example) you would issue a
            command similar to this: </para>

        <programlisting language="sh"><![CDATA[
ln -s /usr/local/share/ZendFramework/bin/zf.sh /usr/local/bin/zf

# OR (for example)
ln -s /home/username/lib/ZendFramework/bin/zf.sh /home/username/bin/zf
]]></programlisting>

        <para>
            This will create a link which you should be able to access globally
            on the command line.
        </para>

    </sect2>

    <sect2 id="zend.tool.framework.clitool.setup-windows">
        <title>Setting up the CLI tool on Windows</title>

        <para>
            The most common setup in the Windows Win32 environment, is to copy
            the <code>zf.sh</code> and <code>zf.php</code> into the same
            directory as your PHP binary. This can generally be found in one of
            the following places:
        </para>

        <programlisting language="text"><![CDATA[
C:\PHP
C:\Program Files\ZendServer\bin\
C:\WAMP\PHP\bin
]]></programlisting>

        <para>
            You should be able to run <code>php.exe</code> on the command line.
            If you are not able to, first check the documentation that came with
            your PHP distribution, or ensure that the path to php.exe is in your
            windows PATH environment variable.
        </para>

        <para>
            The next order of business is to ensure that the Zend Framework
            library is setup correctly inside of the system PHP
            <code>include_path</code>. To find out where your
            <code>include_path</code> is located, you can type 'php -i' and look
            for the <code>include_path</code> variable, or more succinctly
            execute 'php -i | grep include_path' if you have Cygwin setup with
            grep available. Once you have found where your
            <code>include_path</code> is located (this will generally be
            something like <code>C:\PHP\pear</code>, <code>C:\PHP\share</code>,
            <code>C:\Program Files\ZendServer\share</code> or similar), ensure
            that the contents of the library/ directory are put inside your
            <code>include_path</code> specified directory.
        </para>

        <para>
            Once you have done those two things, you should be able to issue a
            command and get back the proper response like this:
        </para>

        <para>
            <inlinegraphic scale="100" align="center" valign="middle"
                fileref="figures/zend.tool.framework.cliversionwin32.png" format="PNG" />
        </para>

        <para>
            If you do not see this type of output, go back and check your setup
            to ensure you have all of the necessary pieces in the proper place.
        </para>

        <para>
            There are a couple of alternative setups you might want to employ
            depending on your server's configuration, your level of access, or
            for other reasons.
        </para>

        <para>
            <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
            Framework download together as is, and altering both your system
            PATH as well as the <code>php.ini</code> file. In your user's
            environment, make sure to add
            <code>C:\Path\To\ZendFramework\bin</code>, so that your
            <code>zf.bat</code> file is executable. Also, alter the
            <code>php.ini</code> file to ensure that
            <code>C:\Path\To\ZendFramework\library</code> is in your
            <code>include_path</code>.
        </para>

    </sect2>

    <sect2 id="zend.tool.framework.clitool.setup-othernotes">
        <title>Other Setup Considerations</title>

        <para>
            If for some reason you do not want the Zend Framework library inside
            your <code>include_path</code>, there is another option. There are
            two special environment variables that <code>zf.php</code> will
            utilize to determine the location of your Zend Framework
            installation.
        </para>

        <para>
            The first is <code>ZEND_TOOL_INCLUDE_PATH_PREPEND</code>, which will
            prepend the value of this environment variable to the system
            (<code>php.ini</code>) <code>include_path</code> before loading the
            client.
        </para>

        <para>
            Alternatively, you might want to use
            <code>ZEND_TOOL_INCLUDE_PATH</code> to completely
            <emphasis>replace</emphasis> the system <code>include_path</code>
            for one that makes sense specifically for the <code>zf</code>
            command line tool.
        </para>
    </sect2>

    <sect2 id="zend.tool.framework.clitool.continuing">
        <title>Where To Go Next?</title>

        <para>
            At this point, your should be setup to start initiating some more
            "interesting" commands. To get going, you can issue the <code>zf
                --help</code> command to see what is available to you.
        </para>

        <para>
            <inlinegraphic scale="100" align="center" valign="middle"
                fileref="figures/zend.tool.framework.clihelp.png" format="PNG" />
        </para>

        <para>
            Continue on to the <code>Zend_Tool_Project</code> "Create Project"
            section to understand how to use the <code>zf</code> script for
            project creation.
        </para>
    </sect2>
</sect1>