CloudQuery JS Source Plugin Template

This is a template for a CloudQuery Source plugin using CloudQuery JavaScript SDK. It creates a simple table called Names with two rows of data.

Read about how to build a new CloudQuery plugin from this template in Creating a New JS Plugin.

Getting started

Install dependencies

npm install

Run the plugin locally

npm run dev

Run cloudquery

cloudquery sync sync.yml

This will create db.sql file (a Sqlite database) with a table Names and two records.

Building and publishing the plugin

1. Update the plugin metadata in src/plugins.ts to match your team and plugin name.
2. Run npm run build to build the plugin.
3. Run node dist/main.js package -m "Initial release" v0.0.1 .. -m specifies changelog and v0.0.1 is the version.
4. Run cloudquery plugin publish -f to publish the plugin to the CloudQuery registry.

More about publishing plugins here