Skip to content

spoonboy-io/lock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lock

A CLI helper tool for Morpheus plugin development and download

GitHub go.mod Go version Go Report Card GitHub Workflow Status GitHub Workflow Status (branch) GitHub Release Date GitHub commits since latest release (by date) GitHub

About

Lock is a CLI tool to assist with Morpheus plugin development and download of prebuilt plugin JAR files.

Users can inspect and clone Morpheus plugin starter templates, tagged by Morpheus tested version or semantic version. Users can also inspect and download prebuilt JAR plugins at a specific version and compatibility.

Lock currently uses share.morpheusdata.com for information about prebuilt plugins and a git repository here to maintain starter template project information.

Releases

You can find the latest software here.

Features

Starter Templates

  • List Morpheus plugin starter templates.
  • Inspect template and its version and Morpheus compatability.
  • Clone a starter template into a new project folder ready for customisation.

Plugins

  • List prebuilt plugins available in JAR format.
  • Inspect plugin, its version history and compatability.
  • Download a plugin by version or latest.

Usage

➜  Demo lock

Usage: lock COMMAND <ARGUMENT> --FLAG(S)

A CLI helper tool for Morpheus plugin development and download

General commands:	
  help                   Show this help section
  version                Show the Lock version information

Starter templates:
  templates              List available starter project templates.
                          --category    The category as a filter
                          --morpheus    The minimum version of Morpheus as a filter
  template <TEMPLATE>    Show template information and available versions, <TEMPLATE> can be name or id.
  pick <TEMPLATE>        Creates new project from a starter template, <TEMPLATE> can be name or id.
                          --name        A project folder name (default: morpheus-plugin-project)
                          --tag         The specific tag to create project from (default: head)

Precompiled plugins:
  plugins                List available Morpheus plugin JAR files.
                          --morpheus    The minimum version of Morpheus as a filter
  plugin <PLUGIN>        Show plugin information and Morpheus version compatibility, <PLUGIN> can be name or id.
  load <PLUGIN>          Download a compiled plugin, <PLUGIN> can be name or id.
                          --version     The specific version of the plugin (default: latest)

Installation

Grab the tar.gz or zip archive for your OS from the releases page. Unpack it and run:

./lock

Make lock available in your $PATH to omit the leading ./

License

Licensed under Mozilla Public License 2.0

Todo/Ideas

  • plugins --morpheus= flag is not yet implemented
  • Java version detection
  • Watcher functionality to build plugin on file save