paperclip-create-plugin

Scaffolds Paperclip plugin packages with manifests, workers, and UI.

Updated Sep 1, 2021
One-click install
npx skills add https://github.com/unclehowell/unclehowell --skill paperclip-create-plugin-unclehowell
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: paperclip-create-plugin
Source: https://github.com/unclehowell/unclehowell/tree/main/skills/paperclip-create-plugin
Command: npx skills add https://github.com/unclehowell/unclehowell --skill paperclip-create-plugin-unclehowell

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide removes uncertainty and manual boilerplate when creating, scaffolding, or documenting Paperclip plugins by providing a clear scaffold workflow, runtime assumptions, verification steps, and documentation expectations.

Core Features & Use Cases

  • Scaffold Automation: Use the create-paperclip-plugin scaffold to generate a ready-to-edit plugin package with manifest, worker, UI, tests, and package metadata.
  • External and In-Repo Support: Supports snapshotting an SDK for plugins developed outside the repo and recommends targets for example or production packages.
  • Verification & Best Practices: Emphasizes capability declarations, route conventions, typechecking, testing, building, and documentation distinctions between current runtime and future specs.
  • Use Case: Quickly create an example plugin for documentation or a local plugin package for development and verify it with typecheck, tests, and build steps.

Quick Start

Scaffold a new Paperclip plugin package named @acme/plugin-name into packages/plugins/examples and prepare it for local development.

Frequently Asked Questions about paperclip-create-plugin

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new Paperclip plugin package from scratch?

To scaffold a Paperclip plugin, use the create-paperclip-plugin generator to produce a ready-to-edit package with manifest, worker, UI, tests, and package metadata. This enforces capability declarations and route conventions for local development.

What files and conventions do I need to create a Paperclip plugin?

Creating a Paperclip plugin requires generating a manifest, worker, UI, and test files that satisfy specific capability and route constraints. The scaffold workflow also enforces package metadata standards for both in-repo and external package workflows.

Can I develop Paperclip plugins outside the main repository?

Yes, you can develop Paperclip plugins externally by snapshotting the SDK for packages outside the repo. The scaffold supports both in-repo example packages and external production package targets with appropriate metadata.

What verification steps are required before deploying a Paperclip plugin?

Deploying a Paperclip plugin requires running typecheck, tests, and build verifications. The scaffold workflow enforces these checks to ensure the plugin satisfies manifest and worker/UI conventions before deployment.

Does the Paperclip plugin scaffold generate test and documentation files?

Yes, the Paperclip plugin scaffold generates test files and supports updating plugin authoring documentation. It distinguishes between current runtime specifications and future specs for both in-repo and external workflows.

Why does scaffolding a Paperclip plugin enforce capability declarations?

Scaffolding enforces capability declarations to ensure the Paperclip plugin satisfies runtime assumptions and route conventions. This removes manual boilerplate and prevents configuration errors when generating the plugin skeleton.