@localctl/cli 0.5.0-beta.3 → 0.5.0

package/README.md

@@ -62,7 +62,7 @@ JSON file per app.
 | 🧩 **One cluster, one CLI** | A single [k3d](https://k3d.io) cluster runs every app you develop. No per-project Kubernetes setup. |
 | 🌐 **A subdomain per app** | `orders.local.test`, `billing.local.test`, routed by Traefik. No `localhost:3000` vs `:3001`. |
 | 🔒 **HTTPS by default** | A locally-trusted wildcard certificate (via [mkcert](https://github.com/FiloSottile/mkcert)). Green padlock, no browser warnings. |
-| 📄 **Config, not YAML** | Each app has one `.local/config.json`. Every Kubernetes manifest is generated from it. |
+| 📄 **Config, not manifests** | Each app has one `.local/config.yaml`. Every Kubernetes manifest is generated from it. |
 | ⚡ **Fast inner loop** | [Tilt](https://tilt.dev) builds, deploys, and live-syncs changed files into the running container. |
 | 🐞 **Debugger-friendly** | Debug ports forwarded to `localhost`. Node, Python, Go, Java and .NET patterns included. |
 | 🗄️ **Databases in one line** | Postgres, Redis and MongoDB per app, from real Helm charts, with credentials injected as Secrets. |
@@ -73,15 +73,14 @@ JSON file per app.
 
 | Requirement | Notes |
 |---|---|
-| **macOS**, **Windows** or **Linux** | Windows commands run in PowerShell. Linux support is [experimental](#linux-experimental). |
+| **macOS** or **Windows** | Windows commands run in PowerShell. |
 | **Node.js 18+** | Needed to install the CLI from npm. |
 | **Container engine** | [Podman Desktop](https://podman-desktop.io/) (or Docker Desktop / Rancher Desktop), running. See [supported container engines](#supported-container-engines). |
-| **Homebrew** (macOS) or **winget** (Windows) | Used once by `localctl setup` to install missing tools. Linux needs only `curl`. |
+| **Homebrew** or **winget** | Used once by `localctl setup` to install missing tools. |
 
 `localctl setup` installs `k3d`, `kubectl`, `tilt`, `mkcert` and `helm` for you if they're missing.
 On Windows, Tilt isn't on winget, so it's downloaded from its GitHub release into
-`~\.localctl\tools` and added to your user PATH. On Linux, all five tools are downloaded as
-official release binaries into `~/.localctl/tools` (no sudo, no distro packages).
+`~.localctl	ools` and added to your user PATH.
 
 ### Supported container engines
 
@@ -90,69 +89,12 @@ official release binaries into `~/.localctl/tools` (no sudo, no distro packages)
 | [Podman Desktop](https://podman-desktop.io/) | ✅ Tested |
 | [Docker Desktop](https://www.docker.com/products/docker-desktop/) | 🧪 Experimental — setup and app deploy verified on Windows |
 | [Rancher Desktop](https://rancherdesktop.io/) | 🧪 Experimental — not yet tested |
-| Docker Engine / native Podman (Linux) | 🧪 Experimental — see [Linux](#linux-experimental) |
 
 Experimental engines are detected and should work, since k3d only needs a Docker-compatible API,
 but they haven't been through a full test cycle yet. `localctl setup` and `localctl doctor` print
 a warning when one is in use. If you try one, please
 [report how it went](https://github.com/psilvmoreira/localctl/issues/new).
 
-### Required tools
-
-What has to be on your machine **before** `localctl setup`, and what `setup` installs for you:
-
-| | You install | `localctl setup` installs |
-|---|---|---|
-| **All platforms** | **Node.js 18+** (to install and run the CLI), a **container engine** | `k3d`, `kubectl`, `tilt`, `mkcert`, `helm` |
-| **macOS** | [Homebrew](https://brew.sh) | via `brew` (plus `nss` for Firefox, optional) |
-| **Windows** | `winget` (ships with Windows) | via `winget`, Tilt from its GitHub release |
-| **Linux** | `curl` and `tar`, `sudo` (hosts file, CA trust) | downloaded as release binaries into `~/.localctl/tools` |
-
-`localctl setup` needs administrator rights once, for the `*.local.test` hosts entry and the local
-CA trust.
-
-### Linux (experimental)
-
-Linux support is **experimental**: the end-to-end suite passes on the distributions below, but
-only in containers on arm64 (amd64 and bare-metal installs are untested), and `setup`/`doctor`
-print a warning. It's published on the `beta` dist-tag:
-
-```sh
-npm install -g @localctl/cli@beta
-```
-
-Targeted distributions, all with systemd and a mkcert-supported trust store:
-
-| Family | Distributions | Docker Engine install |
-|---|---|---|
-| Debian | Ubuntu, Debian, Linux Mint, Pop!_OS | `localctl setup --install-docker` (Docker's official script) |
-| Red Hat | Fedora, RHEL, Rocky, AlmaLinux, CentOS Stream | `localctl setup --install-docker` (Docker's official script on Fedora, Docker's CentOS repository elsewhere) |
-| Arch | Arch, Manjaro, EndeavourOS | `localctl setup --install-docker` (`pacman`) |
-| SUSE | openSUSE Leap/Tumbleweed | `localctl setup --install-docker` (`zypper`) |
-
-Verified end to end (`npm run test:e2e:distros`, see [Contributing](docs/contributing.md)): Ubuntu
-22.04 and 24.04, Debian 12, Fedora 41, Rocky 9, openSUSE Leap 15.6 and Arch Linux ARM. Derivatives
-resolve through `ID_LIKE` in `/etc/os-release` (or `/usr/lib/os-release`) but were not run
-themselves.
-
-Other distributions (Alpine, Void, Gentoo, NixOS, immutable/atomic desktops) may work if you
-bring Docker (or Podman) and Node.js yourself, but aren't targeted. WSL needs the Windows hosts
-file edited too.
-
-What's different on Linux:
-
-- **Docker Engine** is the recommended engine (root daemon, nothing else to configure). If none is
-  running, `localctl setup --install-docker` installs it for the families above. It needs `sudo`,
-  and you must **log out and back in** afterwards so your user joins the `docker` group.
-- **Podman** runs natively, no VM. The insecure-registry entry goes in
-  `~/.config/containers/registries.conf.d/` (no sudo, no restart). k3d needs Podman's API socket:
-  `systemctl --user enable --now podman.socket`. Rootless Podman also can't bind :80/:443 by
-  default: `sudo sysctl net.ipv4.ip_unprivileged_port_start=80`.
-- **Firefox/Chromium trust** needs `certutil` (`libnss3-tools` on Debian/Ubuntu, `nss-tools` on
-  Fedora). `setup` prints the command for your distro; install it and re-run `mkcert -install`.
-
-Hit a problem? [Open an issue](https://github.com/psilvmoreira/localctl/issues/new).
-
 ## Installation
 
 ```sh
@@ -231,7 +173,7 @@ self-contained shim in `~/.localctl/bin` and run `localctl setup` for you:
 localctl app new
 ```
 
-This asks for an app name and port, then creates `.local/config.json` and a `Tiltfile`.
+This asks for an app name and port, then creates `.local/config.yaml` and a `Tiltfile`.
 
 **2. Deploy:**
 
@@ -304,7 +246,7 @@ Run `localctl <command> --help` for every option, or see the full
 
 | Command | Description |
 |---|---|
-| `localctl app new` | Scaffold `.local/config.json` and a `Tiltfile` in the current repository. |
+| `localctl app new` | Scaffold `.local/config.yaml` and a `Tiltfile` in the current repository. |
 | `localctl app up [-f]` | Build, deploy and live-reload the app. Background by default; `-f` for the Tilt UI. |
 | `localctl app down` | Stop the dev loop and remove the app. Keeps its data. |
 | `localctl app reload [-a <name>]` | Force a rebuild and redeploy without waiting for a file change. |
@@ -312,7 +254,7 @@ Run `localctl <command> --help` for every option, or see the full
 | `localctl app logs [name] [-f]` | Show or follow an app's logs. Inside its repository the name is optional. |
 | `localctl app exec [cmd...]` | Open a shell (default `sh`) in the app's pod. |
 | `localctl app prune [-y]` | Delete leftover data (volumes, secrets) of apps already taken down. |
-| `localctl app secrets set <KEY> [value]` | Store a secret as a Kubernetes Secret, never in `config.json`. |
+| `localctl app secrets set <KEY> [value]` | Store a secret as a Kubernetes Secret, never in `config.yaml`. |
 | `localctl app secrets list` / `show [KEY]` / `unset <KEY>` | List, reveal or remove secrets. |
 
 </details>
@@ -332,20 +274,28 @@ Run `localctl <command> --help` for every option, or see the full
 
 ## Configuration
 
-Everything about how an app runs locally lives in its `.local/config.json`:
-
-```json
-{
-  "name": "orders-api",
-  "subdomain": "orders",
-  "port": 3000,
-  "build": { "context": ".", "dockerfile": "Dockerfile" },
-  "env": { "NODE_ENV": "development" },
-  "debug": { "enabled": true, "port": 9229, "type": "node" },
-  "dependencies": [{ "type": "postgres", "database": "orders" }],
-  "sync": [{ "localPath": "./src", "remotePath": "/app/src" }],
-  "tls": true
-}
+Everything about how an app runs locally lives in its `.local/config.yaml`:
+
+```yaml
+name: orders-api
+subdomain: orders
+port: 3000
+build:
+  context: .
+  dockerfile: Dockerfile
+env:
+  NODE_ENV: development
+debug:
+  enabled: true
+  port: 9229
+  type: node
+dependencies:
+  - type: postgres
+    database: orders
+sync:
+  - localPath: ./src
+    remotePath: /app/src
+tls: true
 ```
 
 This deploys `orders-api` at `https://orders.local.test`, with its own Postgres instance and the
@@ -374,7 +324,7 @@ To add your own addon, see [**Adding tools**](https://psilvmoreira.github.io/loc
 ## How it works
 
 ```
- .local/config.json ──► localctl ──► Kubernetes manifests ──► Tilt ──► k3d cluster
+ .local/config.yaml ──► localctl ──► Kubernetes manifests ──► Tilt ──► k3d cluster
    (your app repo)     validates      (generated, never        builds,     Traefik ingress
                        + generates     hand-written)           pushes,     + local registry
                                                                live-syncs  + *.local.test TLS
@@ -393,7 +343,7 @@ The full documentation lives at **[psilvmoreira.github.io/localctl](https://psil
 | [Getting started](https://psilvmoreira.github.io/localctl/getting-started/) | Install and first deploy, step by step |
 | [Architecture](https://psilvmoreira.github.io/localctl/architecture/) | Every component, why it was chosen, multi-project support |
 | [CLI commands](https://psilvmoreira.github.io/localctl/cli-reference/) | Every command and option |
-| [Config schema](https://psilvmoreira.github.io/localctl/config-schema/) | Every `.local/config.json` field |
+| [Config schema](https://psilvmoreira.github.io/localctl/config-schema/) | Every `.local/config.yaml` field |
 | [Debugging](https://psilvmoreira.github.io/localctl/debugging/) | Attach a debugger in Node, Python, Go, Java and .NET |
 | [Adding tools](https://psilvmoreira.github.io/localctl/adding-tools/) | Write your own per-app or cluster-wide addon |
 | [Troubleshooting](https://psilvmoreira.github.io/localctl/troubleshooting/) | Known issues, with cause and fix |
@@ -458,7 +408,7 @@ localctl/
 │   ├── templates/       Tiltfile copied into apps by `localctl app new`
 │   └── scripts/         packaging and test scripts
 ├── cluster/manifests/   cluster-level manifests (TLS store, addon namespace)
-├── schema/              JSON Schema for .local/config.json
+├── schema/              JSON Schema for .local/config.yaml
 ├── examples/            ready-to-run sample apps
 ├── docs/                documentation pages (MkDocs Material, deployed to GitHub Pages)
 ├── overrides/           docs site template overrides (landing page)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localctl/cli",
-  "version": "0.5.0-beta.3",
+  "version": "0.5.0",
   "description": "localctl - local Kubernetes dev platform CLI",
   "keywords": [
     "kubernetes",
@@ -35,10 +35,8 @@
   "scripts": {
     "sync-assets": "node scripts/sync-assets.js",
     "prepack": "node scripts/sync-assets.js",
-    "test": "node scripts/smoke-test.js",
-    "test:pack": "node scripts/pack-test.js",
-    "test:e2e": "node scripts/e2e/run.js",
-    "test:e2e:distros": "node scripts/e2e/distros.js"
+    "test": "node scripts/smoke-test.js && node scripts/schema-check.js && node --test test/config.test.js",
+    "test:pack": "node scripts/pack-test.js"
   },
   "dependencies": {
     "chalk": "^4.1.2",
@@ -50,11 +48,6 @@
     "node": ">=18"
   },
   "localctl": {
-    "platforms": {
-      "darwin": "tested",
-      "win32": "tested",
-      "linux": "experimental"
-    },
     "containerEngines": {
       "podman": "tested",
       "docker": "experimental",