Insight Plugin - CLI Tooling for plugin development
Commands
Analysis
Run Static Code Analysis on the plugin.
This command will run the static code analysis check on the plugin.
Checks
Run analysis, linter and validate on the plugin.
This will allow you to recreate, locally, all the github checks that get run on plugins.
Create
Create a new plugin.
This command will generate the skeleton folder structure and code for a new plugin, based on the provided plugin.spec.yaml file.
Export
Export a plugin Docker image to a tarball.
This tarball can be uploaded as a custom plugin via the import functionality in the InsightConnect UI.
Refresh
Refresh the plugin.
This command will update the current plugin code, when updates are made in the plugin.spec.yaml file, and will also run 'black' to format the code.
Validate
Validate / Run checks against the plugin.
This command performs quality control checks on the current state of the plugin. This should be run before finalizing any new updates.
Samples
Create test samples for actions and triggers.
This command will create new files under the 'tests' folder which can be used to test each new action/trigger. Note if a file already exists for a particular action/trigger, it will be overwritten.
Run
Run an action/trigger from a json test file (created during sample generation)
Server
Run the plugin in HTTP mode.
This allows an external API testing program to be used to test a plugin
Shell
Run the plugin via the docker shell to enable advanced debugging
Convert Event Source
Convert a RapidKit event source to a plugin
This command will generate the skeleton folder structure and code for a new plugin, based on the provided RapidKit config.yaml file.
1 maintainer
Metadata
1 maintainer
Release files for insight-plugin 1.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| insight_plugin-1.11.0.tar.gz | 100.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| insight_plugin-1.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 241.5 kB
Release files / insight_plugin-1.11.0.tar.gz
| Download URL | insight_plugin-1.11.0.tar.gz |
|---|---|
| Size | 100.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
87114a52cd3a0b57389a94140fcd6b5fdac40927b503798a334efc88a20993fa
|
|
BLAKE2b-256 checksum How to use checksums |
e6d324e272deca787c9a571742f5159ccbe81050e54e3ba6d5fd54e956d97aaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / insight_plugin-1.11.0-py3-none-any.whl
| Download URL | insight_plugin-1.11.0-py3-none-any.whl |
|---|---|
| Size | 141.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cfc04527ec9fb6a0638f875f5fe41da355344d4cf7ae750b23bb551cb9e57c47
|
|
BLAKE2b-256 checksum How to use checksums |
ffff77286659d127f79f06b603c951e241d37a2ee3e701b692b8ae9af49a375e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
