@go-to-k/cdkd 0.231.12 → 0.233.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -14,6 +14,8 @@ Drop-in CDK CLI for existing CDK apps — faster deploys via AWS SDK instead of
14
14
 
15
15
  **cdkd complements the AWS CDK CLI rather than replacing it.** Use cdkd in dev/test for rapid iteration and SAM-style local execution; use the AWS CDK CLI in production for full CloudFormation tooling. Install cdkd alongside an existing `cdk deploy` workflow — no migration needed, `cdkd local *` reads deployed state directly via `--from-cfn-stack`. Bidirectional migration is also supported — [import](#importing-existing-resources) into cdkd or [export](#exporting-a-stack-back-to-cloudformation) back to CloudFormation when ready.
16
16
 
17
+ **A natural fit for AI-driven development.** AI coding agents iterate in tight spin-up / tear-down loops — and cdkd keeps each turn short, with fast deploys and an equally fast `cdkd destroy` that deletes via direct SDK calls instead of polling a CloudFormation stack-delete.
18
+
17
19
  > [!IMPORTANT]
18
20
  > cdkd is for dev/test workflows only — early in development, not yet production-ready.
19
21
 
@@ -109,10 +111,16 @@ Reproduce the first two with `./tests/benchmark/run-benchmark.sh all`. See [test
109
111
 
110
112
 
111
113
  ┌─────────────────┐
114
+ │ Asset Build & │ S3 ZIP upload / ECR image build & push
115
+ │ Publish │
116
+ └────────┬────────┘
117
+
118
+
119
+ ┌─────────────────┐
112
120
  │ cdkd Engine │
113
121
  │ - DAG Analysis │ Dependency graph construction
114
122
  │ - Diff Calc │ Compare with existing resources
115
- │ - Parallel Exec │ Event-driven dispatch
123
+ │ - Parallel Exec │ Dispatch on deps complete (no level barrier)
116
124
  └────────┬────────┘
117
125
 
118
126
  ┌────┴────┐
@@ -131,7 +139,7 @@ parsing → synthesis → asset publishing → per-stack deploy), see
131
139
  ## Prerequisites
132
140
 
133
141
  - **Node.js** >= 20.0.0
134
- - **AWS CDK Bootstrap**: You must run `cdk bootstrap` before using cdkd. cdkd uses CDK's bootstrap bucket (`cdk-hnb659fds-assets-*`) for asset uploads (Lambda code, Docker images). Custom bootstrap qualifiers are supported — CDK embeds the correct bucket/repo names in the asset manifest during synthesis.
142
+ - **AWS CDK Bootstrap**: You must run `cdk bootstrap` before using cdkd. By default cdkd uses CDK's bootstrap bucket (`cdk-hnb659fds-assets-*`) for asset uploads (Lambda code, Docker images). Custom bootstrap qualifiers are supported — CDK embeds the correct bucket/repo names in the asset manifest during synthesis. Note: `cdk gc` cannot see cdkd-deployed stacks (no CloudFormation stack to scan) and may garbage-collect cdkd-published assets from the CDK bootstrap storage — run `cdkd bootstrap` to opt a region into cdkd-owned asset storage (`cdkd-assets-*` / `cdkd-container-assets-*`), which asset publishing then redirects to automatically, with template references rewritten to match (issue [#1002](https://github.com/go-to-k/cdkd/issues/1002); design in [docs/design/1002-cdkd-asset-storage.md](docs/design/1002-cdkd-asset-storage.md); `--use-cdk-bootstrap-assets` pins the legacy destinations for CFn-co-deployed apps).
135
143
  - **AWS credentials with admin-equivalent permissions** for the resources being deployed. cdkd does NOT route through CloudFormation, so CDK CLI's `cdk-hnb659fds-deploy-role-*` is NOT sufficient — see [`--role-arn`](docs/cli-reference.md).
136
144
 
137
145
  ## Installation
@@ -148,12 +156,16 @@ The installed binary is `cdkd`.
148
156
  > **First-time setup**: cdkd requires a one-time `cdkd bootstrap` per AWS
149
157
  > account before any other command will work — it creates the S3 state
150
158
  > bucket (`cdkd-state-{accountId}`) that cdkd uses to track deployed
151
- > resources. This is separate from `cdk bootstrap` (which sets up the
159
+ > resources, plus cdkd-owned asset storage for the region
160
+ > (`cdkd-assets-{accountId}-{region}` bucket +
161
+ > `cdkd-container-assets-{accountId}-{region}` ECR repo — skip with
162
+ > `--no-assets`; see [`cdkd bootstrap`](docs/cli-reference.md#cdkd-bootstrap)).
163
+ > This is separate from `cdk bootstrap` (which sets up the
152
164
  > CDK asset bucket / ECR repo and is also required — see
153
165
  > [Prerequisites](#prerequisites)).
154
166
 
155
167
  ```bash
156
- # Bootstrap (creates S3 state bucket — one-time setup, once per AWS account)
168
+ # Bootstrap (creates S3 state bucket + asset storage — one-time setup per AWS account)
157
169
  cdkd bootstrap
158
170
 
159
171
  # List stacks in the CDK app