Creating a plugin
Prerequisites
Section titled “Prerequisites”Before getting started, ensure that Node.js is installed on your system.
Generate the Plugin
Section titled “Generate the Plugin”Navigate to the directory where you want your plugin server to reside. Then, run the following command and follow the prompts:
npm create newsteam-plugin@latestUsing Command-Line Options
Section titled “Using Command-Line Options”The create newsteam-plugin command supports optional parameters that you can provide to customize the generation process without relying on interactive prompts. Here’s a list of supported options:
| Option | Description |
|---|---|
--outPath <string> | Specifies the output path for the plugin (default: "my-plugin"). |
--platform <string> | Specifies the platform for the plugin: |
- typescript: Generates a TypeScript plugin. | |
- csharp: Generates a C# plugin. | |
--bucketid <string> | Sets the unique identifier for categorizing your plugin’s data. |
--port <string> | Sets the port (default: "3333"). |
Example Commands
Section titled “Example Commands”- To generate a TypeScript plugin with a specific Bucket ID and port:
npm create newsteam-plugin@latest -- --outPath my-ts-plugin --bucketid my-bucket --platform typescript --port 3333- To generate a C# plugin with a specific Bucket ID and port:
npm create newsteam-plugin@latest -- --outPath my-csharp-plugin --platform csharp --bucketid my-bucket --port 3333Next Steps
Section titled “Next Steps”Your plugin is now set up! In the next section, we’ll guide you through configuring and customizing it to meet your specific needs.