Skip to content

README.md

Latest commit

 

History

History
78 lines (53 loc) · 4.26 KB

README.md

File metadata and controls

78 lines (53 loc) · 4.26 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 and provides guidance on how to author your own plugin and submit it this repository.

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?

Note

If you're interested in joining our private preview, please contact support@squaredup.com.

Building with Claude Code (build-plugin skill)

If you have access to Claude Code, the build-plugin skill can guide you through building a plugin from scratch — from exploring the API all the way to a deployed, tested plugin with dashboards.

What it does

The skill walks you through the full process in structured phases:

  1. Explores the target API and plans the plugin structure with you
  2. Scaffolds all the required files
  3. Deploys a working version of your plugin early, then pauses for you to authenticate it (OAuth, API key, or whatever the service uses)
  4. Tests imports and indexes objects so real data is flowing before the plugin is finished
  5. Builds and tests each data stream against live data as it goes
  6. Authors out-of-the-box dashboards

Prerequisites

  • Claude Code installed
  • The squaredup CLI installed and logged in (npm i -g @squaredup/cli, then squaredup login)
  • A SquaredUp tenant where you can add and authenticate the plugin

How to use it

Open Claude Code in this repository and type:

/build-plugin

Claude will ask for the API you want to integrate and guide you from there.

Tip

Keeping the skill up to date — the skill lives in this repository and improves over time. To get the latest version, open a terminal in this folder and run git pull origin main before starting a new plugin build.