pantograph Plugins

The instructions below require pantograph 0.1.9 or higher

pantograph is an open platform and we enable every developer to extend it to fit their needs. That's why we built a plugin system that allows you and your company to provide pantograph plugins to other pantograph users. You have the full power and responsibility of maintaining your plugin and keeping it up to date. This is useful if you maintain your own library or web service, and want to make sure the pantograph plugin is always up to date.

Local actions

This content was moved and now lives here.

Find a plugin

Head over to Available Plugins for a list of plugins you can use.

List all available plugins using

pantograph search_plugins

To search for something specific

pantograph search_plugins [query]

Add a plugin to your project

pantograph add_plugin [name]

pantograph will assist you on setting up your project to start using plugins.

This will:

  • Add the plugin to pantograph/Pluginfile
  • Make sure your pantograph/Pluginfile is properly referenced from your ./Gemfile
  • Run pantograph install_plugins to make sure all required dependencies are installed on your local machine (this step might ask for your admin password to install Ruby gems)
  • You'll have 3 new files, that should all be checked into version control: Gemfile, Gemfile.lock and pantograph/Pluginfile

Plugin Source

Your pantograph/Pluginfile contains the list of all pantograph plugins your project uses. The Pluginfile is a Gemfile that gets imported from your main Gemfile. You specify all dependencies, including the required version numbers:

# Fetched from RubyGems.org
gem 'pantograph-plugin-maven'

# Fetched from GitHub
gem 'pantograph-plugin-maven', git: 'https://github.com/urbanquakers/pantograph-plugin-maven'

# Fetched from a local directory
gem 'pantograph-plugin-maven', path: '../pantograph-plugin-maven'

# Specify a version requirements
gem 'pantograph-plugin-maven', '1.1.0'
gem 'pantograph-plugin-maven', '>= 1.0'

More information about a Gemfile

Run with plugins

Run pantograph using bundle exec pantograph [lane] to make sure your plugins are properly loaded.

This is required when you use plugins from a local path or a git remote. If you have multiple versions of the same plugin loaded, you may not be using the one you specified in your Pluginfile or Gemfile.

Install plugins on another machine

To make sure all plugins are installed on the local machine, run

pantograph install_plugins

Update all plugins

To make sure all plugins are updated to the latest version, run

pantograph update_plugins

Remove a plugin

Open your pantograph/Pluginfile and remove the line that looks like this

gem 'pantograph-plugin-[plugin_name]'