Skip to content

README.md

Latest commit

 

History

History
88 lines (60 loc) · 5.37 KB

README.md

File metadata and controls

88 lines (60 loc) · 5.37 KB
Raw

SquaredUp Community Plugins

Discourse Users Plugins GitHub issues License

SquaredUp is the operational intelligence platform that enables data-driven IT and engineering teams to make better decisions, faster. Learn more.

SquaredUp dashboard

About this repository

SquaredUp has 60+ plugins out of the box. This repository contains all community-authored plugins, the build-plugin AI skill used to author them, and guidance on submitting your own plugin here.

Reporting issues or feature requests

What is a plugin?

Plugins are key components of SquaredUp. Each plugin defines how connect to and read data from a third-party system. A plugin typically includes:

  • Plugin metadata - name, logo, author etc.
  • Data streams - specify data is queried from a third-party system, typically a wrapper around a certain API endpoint
  • Out of the box dashboards - useful dashboards to help users get started
  • Index definition - defines how SquaredUp indexes objects from a third-party system

Tip

We use the term plugins in code, while the UI refers to them as data sources.

Learn more about plugins

How do I use a data source?

  • Sign up for an account at app.squaredup.com
  • Browse to Data Sources -> +
  • Select your desired data source from our catalog
  • Configure and add the data source to get started

Learn more about adding a data source

How do I build my own plugin?

Plugins are built with the build-plugin AI skill, which lives in this repository and is generally available to everyone. Point your AI coding agent at it and it takes you from an API reference to a deployed, tested plugin — exploring the API, planning the plugin with you, scaffolding the files, deploying and pausing for you to authenticate, testing every data stream against live data, and authoring out-of-the-box dashboards.

Prerequisites

  • Node.js 22 or later
  • The squaredup CLI, installed and logged in: npm i -g @squaredup/cli, then squaredup login
  • An AI coding agent — Claude Code is recommended
  • A SquaredUp organization where you can add and authenticate a data source
  • Documentation for the API you want to integrate, and credentials with real data behind them

Quick start

Clone this repository and start your agent in it:

git clone https://github.com/squaredup/plugins.git
cd plugins
claude

Then ask for the skill:

/build-plugin

The agent will ask which API you want to integrate and guide you from there. Expect to stay in the loop at three points: supplying the API documentation, approving the plan, and authenticating the plugin in your organization.

Tip

The skill improves over time. Run git pull origin main in this folder before starting a new plugin build to pick up the latest version.

📺 Watch the video introduction and read the full guide — including how to run the skill in agents other than Claude Code (Codex, Cursor, Gemini CLI, GitHub Copilot and many more).

How do I submit my plugin?

Community-authored plugins are welcome — open a pull request against this repository.

  • Add your plugin as plugins/<PluginName>/v1/, matching the layout of an existing plugin (metadata.json, ui.json, icon.svg, dataStreams/, indexDefinitions/, defaultContent/, docs/README.md)
  • Include a logo, at least one dashboard, and a docs/README.md covering configuration
  • Never commit secrets, API keys or credentials
  • For changes to an existing plugin, bump version in metadata.json. Breaking changes need a new major version folder (e.g. v2/) alongside the old one, so existing users aren't broken
  • Add yourself to .github/CODEOWNERS so you're asked to review future changes to your plugin
  • Open your PR using the Add a new plugin template; a community moderator will review it

By contributing you agree to our Code of Conduct.