Skip to content

Add readme notes on using the build-plugin skill #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clarkd merged 1 commit into from
Jun 26, 2026
Merged

Add readme notes on using the build-plugin skill #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,37 @@ Plugins are key components of SquaredUp. Each plugin defines how connect to and
## 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](https://claude.ai/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](https://claude.ai/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
Comment on lines +46 to +65

@coderabbitai coderabbitai Bot Jun 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Add the REST-only scope caveat.

The upstream skill is explicitly limited to web API-based plugins and says to stop if the target tool has no usable REST API. Without that note, this README overstates when the skill applies.

Suggested patch 
 ### Building with Claude Code (build-plugin skill)
 
 If you have access to [Claude Code](https://claude.ai/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.
+> [!NOTE]
+> This skill is for web API-based plugins only. If the target tool has no usable REST API, PowerShell may be a better fit.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Building with Claude Code (build-plugin skill)
If you have access to [Claude Code](https://claude.ai/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](https://claude.ai/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
### Building with Claude Code (build-plugin skill)
If you have access to [Claude Code](https://claude.ai/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.
> [!NOTE]
> This skill is for web API-based plugins only. If the target tool has no usable REST API, PowerShell may be a better fit.
**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](https://claude.ai/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
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 46 - 65, Update the “Building with Claude Code
(build-plugin skill)” section in README to add the REST-only limitation: the
build-plugin skill should be described as applicable only to web API/REST-based
plugins, and readers should be told to stop or choose another path if the target
service does not expose a usable REST API. Keep the existing flow description,
but adjust the introductory text near the build-plugin mention so it does not
imply the skill works for non-REST integrations.


**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.
Loading