@tdk-landscape/tdk-cli-core 1.3.112 → 1.3.114
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 +20 -1
- package/cli/dist/commands/status.js +4 -1
- package/cli/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ English | [简体中文](README-zh_cn.md) | [繁體中文](README-zh_tw.md) | [
|
|
|
15
15
|
|
|
16
16
|
TDK CLI starts your services on your laptop. It is not a deploy and not a Compose file: define each service in `service.json`, then run `tdk up`. No Kubernetes is needed on the machine.
|
|
17
17
|
|
|
18
|
-
Stability: 1.x local dev.
|
|
18
|
+
Stability: 1.x local dev. Write `service.json`; TDK generates the local runtime files. See [what TDK writes](docs/generated-files.md) and how to check for drift. Core CLI is MIT and needs no key. Premium is optional.
|
|
19
19
|
|
|
20
20
|
Docker runs the containers. Tilt watches services and live-updates containers while you code. TDK CLI writes the configuration Tilt uses. Production deployment stays with Helm, Argo CD, or Kustomize.
|
|
21
21
|
|
|
@@ -39,6 +39,24 @@ curl http://api.shop.localhost/api/orders-api/health
|
|
|
39
39
|
|
|
40
40
|
*Scaffolding a backend and frontend, then listing the stack.*
|
|
41
41
|
|
|
42
|
+
### What TDK writes for a frontend
|
|
43
|
+
|
|
44
|
+
You maintain `service.json`; TDK generates the local runtime files. A frontend such as `services/store/storefront-web` has files like these after generation:
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
services/store/storefront-web/
|
|
48
|
+
├── service.json # your service definition
|
|
49
|
+
└── .autogenerated/ # TDK writes these files
|
|
50
|
+
├── nginx.autogenerated.conf # serves the build and routes API requests
|
|
51
|
+
├── Dockerfile.app.autogenerated # local app image
|
|
52
|
+
├── .env.frontend.autogenerated # local frontend environment
|
|
53
|
+
├── vite.config.frontend.autogenerated.ts
|
|
54
|
+
├── tsconfig.autogenerated.json
|
|
55
|
+
└── api-client.ts # generated API client
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
You do not need to write the nginx config, Dockerfile, or a `docker-compose.yml` for this local stack. `tdk up` uses Docker and Tilt to start it. The [generated-files guide](docs/generated-files.md) lists the other outputs and explains how regeneration and drift checks work.
|
|
59
|
+
|
|
42
60
|
|
|
43
61
|
|
|
44
62
|
If Helm, Compose, or your existing Tilt setup already gives you a working local environment, keep using it. TDK CLI is for engineers managing several services who want a clear local service contract and one command to start the stack.
|
|
@@ -79,6 +97,7 @@ curl -fsSL https://tdk-landscape.github.io/install.sh | sh
|
|
|
79
97
|
- [Pilot scorecard](docs/pilot-scorecard.md)
|
|
80
98
|
- [Bring-your-own resources](docs/byo.md)
|
|
81
99
|
- [Configuration and editor schemas](docs/configuration.md)
|
|
100
|
+
- [Generated service files and drift checks](docs/generated-files.md)
|
|
82
101
|
- [Runnable one-backend example](examples/one-backend/README.md)
|
|
83
102
|
- [Runnable Python backend example](examples/one-backend-python/README.md)
|
|
84
103
|
- [Full multi-service example](examples/tdk-example/README.md)
|
|
@@ -87,6 +87,7 @@ export const statusCommand = new Command("status")
|
|
|
87
87
|
resources: tiltResources,
|
|
88
88
|
readiness,
|
|
89
89
|
},
|
|
90
|
+
resourceCount: discovery.resources.length,
|
|
90
91
|
resources: discovery.resources.map((resource) => ({
|
|
91
92
|
name: resource.name,
|
|
92
93
|
stack: resource.stack ?? null,
|
|
@@ -98,7 +99,9 @@ export const statusCommand = new Command("status")
|
|
|
98
99
|
stacks: discovery.stacks.map((stack) => ({
|
|
99
100
|
name: stack.name,
|
|
100
101
|
resourceCount: stack.resourceCount,
|
|
102
|
+
resources: stack.resources.map((resource) => resource.name),
|
|
101
103
|
})),
|
|
104
|
+
unassignedResources: discovery.unassignedResources.map((resource) => resource.name),
|
|
102
105
|
};
|
|
103
106
|
console.log(JSON.stringify(createMachineEnvelope(data, errors)));
|
|
104
107
|
if (errors.length > 0) {
|
|
@@ -144,7 +147,7 @@ export const statusCommand = new Command("status")
|
|
|
144
147
|
}
|
|
145
148
|
}
|
|
146
149
|
console.log();
|
|
147
|
-
showDetail('Run "tdk
|
|
150
|
+
showDetail('Run "tdk stacks" to see all stacks.');
|
|
148
151
|
showDetail('Run "tdk up <stack-name>" to start a stack.');
|
|
149
152
|
};
|
|
150
153
|
if (options.json) {
|
package/cli/package.json
CHANGED