Forkmodule-cli is a simple php command line program that helps you create new plugins for ForkCMS by creating a skeleton of boilerplate directories and files that you otherwise need to create by hand.
- Features
Currently Forkmodule-cli only supports creating a module from scratch. It will create all frontend and backend actions and widgets files that you need. You can then get started with writing code instead of creating directories for half an hour.
- Based on Symfony Console
- Twig templates for easy templating
- Built-in support for fork tags, fork search engine, fork meta/seo
- Configuration
When you run forkmodule-cli, it will ask you everything it needs to know.
- Installing forkmodule-cli on your system
Assuming you're on Mac OSX or GNU/Linux with git, php and curl installed:
git clone https://github.com/turanct/forkmodule-cli.git /usr/local/forkmodule-cli && cd /usr/local/forkmodule-cli && curl -sS https://getcomposer.org/installer | php && php composer.phar install && ln -s /usr/local/forkmodule-cli/forkmodule.php /usr/local/bin/forkmodule && cd -
Or you could use the installer, do this (the installer will allow you to use a prefix):
curl https://raw.github.com/turanct/forkmodule-cli/master/install.sh | sh
You can now run the forkmodule command from your command line.
- Updating to the latest version
Run this in your terminal, assuming you used the installer to install forkmodule-cli
cd /usr/local/forkmodule-cli/ && git pull origin master && php composer.phar install && cd -
This will fetch the latest commits on the master branch of this repo.
Alternatively if you're using a recent version of forkmodule-cli, you can just run this command from anywhere in your terminal to update your current install to the newest version:
forkmodule update
- Usage
You can use forkmodule-cli to create a module by running it, like this:
forkmodule
Alternatively, you can specify the name of the module as a parameter, like this:
forkmodule create module_name_here
- License
Forkmodule-cli is licensed under the MIT License