Connery SDK is an NPM package that includes both an SDK and a CLI, designed for the development of plugins and actions.
The CLI automates many things in the development process. Meanwhile, the SDK offers a JavaScript API for defining plugins and actions and packaging them into a plugin server with a standardized REST API generated from the metadata. The plugin server handles authorization, input validation, and logging. So you can focus on the logic of your actions.
The standardized API enables various clients to interact
with actions in a unified way, regardless of the underlying implementation.
An action consists of JavaSctipt code that defines its logic and metadata that describes its input and output. The action can communicate with external APIs, databases, or other services.
👉 Example: Send email is an action in the connery-io/gmail plugin.
Initialize a new plugin with a sample action:
npx connery@latest dev init
Install the dependencies:
npm install
Run the plugin server:
npm start
Open the plugin in the browser: localhost:4201.
👉 Check out the full quickstart guide to learn more.
👉 Learn more: Slack client.
Please give the repository a star to support the project and stay up-to-date with the latest news.
Check out the documentation to learn more.
Connery is still in early beta, so not everything is perfect yet. Please let us know of any suggestions, ideas, or bugs you encounter, and we will use your feedback to improve our upcoming releases.
You can reach us via the following channels:
- Discussions - for feedback, questions, and discussions.
- Issues - for bug reports and feature requests.
- Twitter - for updates and announcements.
This is a monorepo that contains the following components:
Name | Path | Description |
---|---|---|
SDK & CLI | ./packages/connery |
The connery package that contains both the SDK and CLI for plugins and actions development. |
Docs | ./docs |
The documentation website. |
We are open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
For detailed information on how to contribute, see our contributing guide.