This feature is currently in beta. Beta features are subject to quick, iterative changes. As a result, this document may not reflect the most current version.

Sigma’s development team has created a set of example plugins, listed below.

All of our example plugins are hosted and can be added to your organization. To add an example plugin to your organization, follow the steps to register a plugin using its Production URL, listed below.

You can also visit Sigma’s Sample Plugin repository directly on Github.

Summary of Content

Examples
Use an Example in Your Organization
Run an Example Locally
Related Resources

Examples

Use an Example in Your Organization

To add an example plugin to your organization, follow the steps to register a plugin using its Production URL, listed in the Examples section above.

Run an Example Locally

  1. Open your terminal, and navigate to the directory you want to save the example’s in.
  2. Clone Sigma’s Sample Plugin repository.
    git clone https://github.com/sigmacomputing/sigma-sample-plugins.git 
  3. Navigate to the plugin you would like to try.
    cd sigma-sample-plugins/<plugin-name>
  4. Run the plugin.
    yarn && yarn start
    Note: For additional instructions, visit the README file located in the main directory of any given example plugin.

Related Resources

Get Started with Custom Plugins (Beta)
Register a Plugin with your Sigma Organization (Beta)