@orcdkestrator/orcdk-plugin-cdklocal
v1.0.0
Published
CDK CLI interception plugin for LocalStack integration with Orcdkestrator
Downloads
7
Maintainers
Readme
Orcdkestrator Plugin: Cdklocal
CDK CLI interception plugin for LocalStack integration with Orcdkestrator
Installation
npm install @orcdkestrator/orcdk-plugin-cdklocal --save-devConfiguration
Add to your orcdk.config.json:
{
"plugins": [
{
"name": "cdklocal",
"enabled": true,
"config": {
// Plugin-specific configuration
}
}
]
}Usage
See configuration section above and examples directory for detailed usage.
API Reference
See API Documentation for detailed information.
Configuration Options
| Option | Type | Default | Description | |--------|------|---------|-------------| | enabled | boolean | true | Enable/disable the plugin |
Prerequisites
This plugin requires aws-cdk-local CLI to be installed:
npm install -g aws-cdk-localHow It Works
The plugin intercepts CDK CLI command executions and replaces them with cdklocal equivalents when running in local mode.
Examples
See the examples directory for complete examples.
Development
# Clone the repository
git clone https://github.com/orcdkestrator/orcdk-plugin-cdklocal.git
# Install dependencies
npm install
# Run tests
npm test
# Build
npm run buildContributing
See CONTRIBUTING.md for contribution guidelines.
License
MIT - see LICENSE for details.
<!-- CI test -->
