Develop Peek Plugins

Synerty recommends the Atlassian suite of developer tools.

Bitbucket to manage and share your Git repositories


SourceTree to visually manage and interact with your Git repositories


Bitbucket can be integrated with Jira (issue management) and Bamboo (continuous integration).


The reader needs be familiar with, or will become familar with the following:


This a cross platform development guide, all commands are writen for bash.

Bash is installed by default on Linux.

Windows users should use bash from msys, which comes with git for windows, Setup Msys Git.

Clone a New Peek Plugin

If you’re creating a new plugin you can copy from “peek-plugin-noop” and rename.

Copy peek-plugin-noop


Go to, peek-plugin-noop repository on Bitbucket


Clone the repository

  1. This URL will be automatically populated from Bitbucket.
  2. Alter this name to end with peek-plugin-example.

Remove the git references into new directory structure, run the following commands in the bash shell:

cd peek-plugin-example
rm -rf .git .idea .vscode

Rename to New Plugin

Edit the file in the plugin root project folder.

Update the variables near the top with the new names:


Run, run the following command in the bash shell:

bash ./

Remove the “” script, run the following command in the bash shell:


Add to GIT

Create new repository on GitHub.



Bitbucket will also provide instructions on how to do the following.

Get the git url, it will look something like:

https://{account username}{account username}/example.git

Run the following commands in bash shell to add the plugin to the git repository:

git init
git add .

Create your first commit:

git commit -m "Scaffolded example plugin"

Add remote:

git remote add origin {insert your GitHub link}

Push your changes:

git push -u origin master

Cloning an Existing Peek Plugin

Create your own fork of the plugins if you don’t already have one.


Be sure to check your fork syncing is enabled and up to date, Otherwise you’ll run into issues.


Clone the fork


Setup an IDE

An integrated development environment (IDE), is an advanced text editor with the following features.

  • Syntax highlighting
  • Error highlighting
  • Integrating build tools
  • Debugging
  • Linting - checking code for quality.

The Peek documentation has procedures for IDE setup: