Overview

This entry is a continuation of the Solar CLI series--a series that aims to detail Solar CLI commands, available options, parameters, and usage examples. In this entry we take a look at make-vendor, a command to generate a new project, otherwise known as a "vendor space."

First Glance

Before any application, model, etc. can be created in a Solar System, a vendor space must be created. This generates the foundation for your project. Let's first start by taking a look at what help can tell us about the command make-vendor.

Note: It is assumed that your Solar System is installed under /var/www/solar/.

If you have not done so already, change directories to the root of your Solar System. In our case, that would be /var/www/solar/.

Help Information

$ ./script/solar help make-vendor
Using include_path '.:..:/var/www/solar/include'.
Using config file '/var/www/solar/config/Solar.config.php'.

No help is available for this command.

Valid options for this command are...

--config
:  Use this configuration file when starting Solar.

-V | --version
:  Display version information and exit.

-v | --verbose
:  Display verbose output when available.

Available Options

None

Available Parameters

Name: The vendor name. This is required. An example would be, Vendor. See the list of known public vendors.

Usage examples

To create a new vendor space, simply do the following.

$ ./script/solar make-vendor Vendor

The following directories are generated.

• /source/vendor/bin/
• /source/vendor/docs/
• /source/vendor/tests/
• /source/vendor/Vendor/App/
• /source/vendor/Vendor/App/Public/
• /source/vendor/Vendor/App/Public/images/
• /source/vendor/Vendor/App/Public/scripts/
• /source/vendor/Vendor/App/Public/styles/
• /source/vendor/Vendor/Model/
• /source/vendor/Vendor/Locale/
• /source/vendor/Vendor/View/
• /source/vendor/Vendor/View/Helper/

And the following symlinks (*nix only) are made.

• /source/vendor/Vendor/ to /include/Vendor
• /source/vendor/Vendor/App/Public/ to /docroot/public/Vendor/
• /source/solar/bin/solar to /script/vendor

For a good explanation of the important directories and symlinks that are generated, please see the Skeleton System page in the Solar manual.

What's Next?

In my next post I will cover make-model, a command that is hard to live without.

Until then, join the Solar mailing list and/or IRC channel and give us a big "Hello!"--we'd love to hear from you.