@tdk-landscape/tdk-cli-core 1.3.81 → 1.3.82
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 +19 -27
- package/cli/package.json +2 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,25 @@
|
|
|
1
|
-
# TDK —
|
|
1
|
+
# TDK CLI — start services on your laptop
|
|
2
2
|
|
|
3
|
-
TDK
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
Docker runs the containers. Tilt runs the development loop. TDK CLI writes that configuration. Production deployment stays with Helm, Argo CD, or Kustomize.
|
|
4
6
|
|
|
5
7
|
[Website](https://tdk-landscape.github.io/tdk-website/) · [Quickstart](https://tdk-landscape.github.io/tdk-website/docs/quickstart/) · [Examples](https://tdk-landscape.github.io/tdk-website/docs/examples/) · [Awesome TDK](https://github.com/tdk-landscape/awesome-tdk-framework) · [Demo](https://tdk-landscape.github.io/tdk-demo-animation/) · [Report a bug](https://github.com/tdk-landscape/tdk-cli-core/issues)
|
|
6
8
|
|
|
9
|
+
## Quick start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
mkdir shop && cd shop
|
|
13
|
+
tdk project --yes
|
|
14
|
+
tdk resource orders-api --type backend --stack shop --yes
|
|
15
|
+
tdk up shop
|
|
16
|
+
curl http://api.shop.localhost/api/orders-api/health
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
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.
|
|
20
|
+
|
|
21
|
+
See [how TDK CLI works alongside Helm](https://tdk-landscape.github.io/tdk-website/docs/with-helm/), the [service schema](engine/schemas/service-schema.json), and the [project configuration schema](engine/schemas/project-schema.json).
|
|
22
|
+
|
|
7
23
|
[](https://www.npmjs.com/package/@tdk-landscape/tdk-cli-core)
|
|
8
24
|
[](https://github.com/tdk-landscape/tdk-cli-core/actions/workflows/ci.yml)
|
|
9
25
|
[](https://github.com/tdk-landscape/tdk-cli-core/actions/workflows/quickstart-e2e.yml)
|
|
@@ -23,36 +39,12 @@ npm install -g @tdk-landscape/tdk-cli-core
|
|
|
23
39
|
curl -fsSL https://tdk-landscape.github.io/install.sh | sh
|
|
24
40
|
```
|
|
25
41
|
|
|
26
|
-
## Quick start
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
mkdir shop && cd shop
|
|
30
|
-
tdk project --yes
|
|
31
|
-
tdk resource orders-api --type backend --stack shop --yes
|
|
32
|
-
tdk up shop
|
|
33
|
-
tdk networks
|
|
34
|
-
```
|
|
35
|
-
|
|
36
42
|
`tdk up shop --dry-run` previews selected local services and URLs before starting containers. The default starter is Bun/TypeScript; TDK's core role is running local containers through Docker + Tilt, not providing a Node.js application framework. See the [one-backend example](examples/one-backend/README.md).
|
|
37
43
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
*Scaffolding a backend and frontend, then listing the stack.*
|
|
41
|
-
|
|
42
|
-
## Why TDK?
|
|
43
|
-
|
|
44
|
-
| | Compose | Local Kubernetes (kind, minikube) | Plain Tilt | **TDK** |
|
|
45
|
-
|---|---|---|---|---|
|
|
46
|
-
| Scaffold a service in one command | ❌ | ❌ | ❌ | ✅ `tdk resource` |
|
|
47
|
-
| Hot reload on file change | ⚠️ `compose watch` config | ⚠️ extra tooling | ✅ | ✅ |
|
|
48
|
-
| Health-checked startup order | ✅ | ✅ | ⚠️ configure it yourself | ✅ |
|
|
49
|
-
| Needs a cluster | No | Yes | Optional | **No** |
|
|
50
|
-
|
|
51
|
-
100 generated health-check services reached healthy in 112 s, using about 1.6 GiB in service-container memory on a 16 GB machine. [Details and caveats](docs/scale-bench.md).
|
|
52
|
-
|
|
53
44
|
## When not to use TDK
|
|
54
45
|
|
|
55
46
|
- Your existing Compose or Tilt workflow already gives you a working local environment.
|
|
47
|
+
- Helm is your whole development workflow and you do not want local services on Docker.
|
|
56
48
|
- You do not want `service.json` manifests and generated local configuration.
|
|
57
49
|
|
|
58
50
|
## Docs
|
package/cli/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tdk-cli-internal",
|
|
3
3
|
"private": true,
|
|
4
|
-
"version": "1.3.
|
|
5
|
-
"description": "TDK CLI
|
|
4
|
+
"version": "1.3.82",
|
|
5
|
+
"description": "TDK CLI — start services on your laptop. Not a deploy or Compose file.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"tdk",
|
|
8
8
|
"tilt",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tdk-landscape/tdk-cli-core",
|
|
3
|
-
"version": "1.3.
|
|
4
|
-
"description": "TDK
|
|
3
|
+
"version": "1.3.82",
|
|
4
|
+
"description": "TDK CLI — start services on your laptop. Not a deploy or Compose file.",
|
|
5
5
|
"homepage": "https://tdk-landscape.github.io/tdk-website",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|