cdk-cli

1.1.0 verified Sat Apr 25 auth: no javascript maintenance

cdk-cli is an unofficial AWS CDK CLI helper that provides additional utility commands for AWS CDK applications. The package is version 1.1.0 and is in maintenance mode; it does not replace the official AWS CDK CLI but offers shortcuts and wrappers. Its key differentiator is simplifying common CDK workflows, though it lacks active documentation and may have limited community support compared to the official tool.

Common errors

error TypeError: cdkCli is not a function ↓

cause Incorrect import naming; using a named export that doesn't exist.

fix

Use 'import cdkCli from 'cdk-cli'' or 'import { CdkCli } from 'cdk-cli''.

error Error: Cannot find module 'cdk-cli' ↓

cause Package not installed or not in node_modules.

fix

Run 'npm install cdk-cli' to install the package.

Warnings

deprecated Package is no longer actively maintained; use official AWS CDK CLI instead. ↓

fix Migrate to the official AWS CDK CLI tool.

gotcha The package does not validate command arguments; invalid commands may cause silent failures. ↓

fix Double-check command names and stack names before calling the function.

breaking In version 1.1.0, the signature of the default export changed from accepting a string to an object. ↓

fix Update calls to pass an object with 'command' and 'stack' properties instead of a single string.

Install

npm install cdk-cli

yarn add cdk-cli

pnpm add cdk-cli

Imports

default
```
import cdkCli from 'cdk-cli';
```
The package exports a single default function.
CdkCli
wrong
```
const CdkCli = require('cdk-cli');
```
correct
```
import { CdkCli } from 'cdk-cli';
```
Named export available as an alternative to default import.
run
wrong
```
import run from 'cdk-cli';
```
correct
```
import { run } from 'cdk-cli';
```
The 'run' function is a named export, not default.

Quickstart

Shows basic usage of the default import to execute a CDK deploy command with options.

import cdkCli from 'cdk-cli';

async function main() {
  const result = await cdkCli({
    command: 'deploy',
    stack: 'MyStack',
    profile: 'default',
  });
  console.log(result);
}

main().catch(console.error);