The Atools Plugin is for Grav CMS. Anarchy Tools suite extends additional functionality to both the grav cli and grav admin plugins, mainly for the developer experience.
Installing the Atools plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
GPM Installation (Preferred)
The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install atools
This will install the Atools plugin into your
/user/plugins directory within Grav. Its files can be found under
To install this plugin, just download the zip version of this repository and unzip it under
/your/site/grav/user/plugins. Then, rename the folder to
atools. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
If you use the admin plugin, you can install directly through the admin plugin by browsing the
Plugins tab and clicking on the
Before configuring this plugin, you should copy the
user/config/plugins/atools.yaml and only edit that copy.
Here is the default configuration and an explanation of available options:
Note that if you use the admin plugin, a file with your configuration, and named atools.yaml will be saved in the
user/config/plugins/ folder once the configuration is saved in the admin.
Use the command
bin/plugin atools followed by one of the following:
list: Lists all installed plugins
en PLUGINNAME: Enables the plugin PLUGINNAME
dis PLUGINNAME: Disables the plugin PLUGINNAME
A plugin developer can use the
AtoolsPlugin::disablePlugin($message, $level, $plugin_name) php function to disable a plugin.
$message: the message logged to admin/ Grav log
$level: Log level
$plugin_name: Slug name of plugin
bin/plugin atools enable admin
Atools name is inspired by the Drupal Chaos Tool Suite, aka ctools
- Check dependencies for plugins.
- Make sure that a plugin exists before attempting enabling/ disabling it.
- More functionality to come.