@inquir/compute-cli 0.1.4 → 0.2.1

package/README.md

@@ -4,18 +4,30 @@ CLI for workspace-first Inquir Compute development.
 
 ## Install
 
-Global:
+Global (recommended). `@latest` also upgrades an existing install to the newest
+published version:
 
 ```bash
-npm install -g @inquir/compute-cli
+npm install -g @inquir/compute-cli@latest
 ```
 
-Or run with `npx`:
+Verify it's on your `PATH`:
 
 ```bash
-npx @inquir/compute-cli --help
+inquir --version
+inquir --help
 ```
 
+Or run without installing:
+
+```bash
+npx @inquir/compute-cli@latest --help
+```
+
+> Requires **Node.js 22+**. To upgrade later, re-run the install command above. On
+> macOS/Linux you may need `sudo` for a global install, or use a Node version
+> manager (nvm/fnm) to avoid it. To remove: `npm uninstall -g @inquir/compute-cli`.
+
 ## Concepts
 
 - **Function**: a single compute unit with typed input/output (Zod schemas). Defined with `defineFunction()`. Run locally with `inquir run`, deployed and invoked remotely with `inquir deploy` / `inquir invoke`.
@@ -134,6 +146,68 @@ OIDC auth), or run `inquir deploy --ci`.
 - `inquir rollback <function> [deployId]` - roll back to a previous successful deploy.
 - `inquir delete <function>` - delete a remote function (asks for confirmation; `--yes` to skip).
 
+**Container services (apps)**
+
+Long-lived containers from any OCI image — the counterpart to functions. HTTP
+ports are served over a hostname; TCP ports are published and dialled directly,
+so a database, SMTP relay or SSH endpoint is a first-class service with no
+runtime adapter involved.
+
+- `inquir apps list` - list applications.
+- `inquir apps create <name> [--port <n>] [--tcp …] [--set K=V]` - create an application.
+- `inquir apps deploy <app> [--image <ref>]` - start a release and wait until it is healthy. Without `--image` the current directory (or `--dir`) is built from its Dockerfile first; `--build <id>` releases an existing build.
+- `inquir apps build <app> [--dir <path>] [--dockerfile <f>] [--context <dir>] [--build-arg K=V]` - build an image from source without releasing it.
+- `inquir apps builds <app>` - build history (`--cancel <buildId>` drops a queued build).
+- `inquir apps status <app>` - endpoints, hostnames and recent releases.
+- `inquir apps logs <app|release|build> [--tail <n>]` - stream container (or build) logs.
+- `inquir apps promote <release>` - send production traffic to a release (needs a login, not an API key).
+- `inquir apps rollback <app>` - return production to the previous release.
+- `inquir apps stop <release>` - stop any release that is not serving production.
+- `inquir apps exec <app> -- <command>` - run a command inside the container (owner/admin login only — it can read every secret).
+- `inquir apps update <app> [--set K=V] [--port …] [--egress none|full] …` - change settings; applies to the next release.
+- `inquir apps domain <app> [hostname] [--verify|--remove]` - bind a custom hostname; publish the printed TXT record and point DNS at the platform, then `--verify`.
+- `inquir apps delete <app> --yes` - archive an application (stops every release, unbinds every hostname).
+
+```bash
+# an HTTP service built from the Dockerfile in the current directory
+inquir apps create web --port 3000
+inquir apps deploy web
+inquir apps promote <releaseId>
+
+# ...or from a prebuilt image
+inquir apps deploy web --image nginx:alpine
+
+# a database: no HTTP port at all, published on a pinned port,
+# health-checked by asking the service itself
+inquir apps create db \
+  --tcp postgres:5432:public:25432 \
+  --health-command "pg_isready -h 127.0.0.1" \
+  --set POSTGRES_PASSWORD=secret
+inquir apps deploy db --image postgres:16-alpine
+```
+
+`--tcp name:port[:public][:hostPort]` — `public` publishes beyond loopback,
+and a pinned `hostPort` keeps a connection string valid across restarts (an
+unpinned port is reassigned every time the container is recreated). A public
+TCP port is reachable by anyone who can reach the host: the platform
+terminates no TLS and checks no credentials on raw TCP, so the service must
+authenticate its own clients.
+
+**Staying up to date**
+
+The CLI keeps itself in step with the platform. On start it checks — at most
+every 12 hours, with a 2.5 s network timeout, never failing your command — the
+npm registry for the latest `@inquir/compute-cli` and the API for the minimum
+version it still supports (`GET /v1/cli/version`). When a newer version exists
+and the CLI is a global npm install running in an interactive terminal, it
+updates itself and re-runs your command; in CI, under `--json`, without a TTY,
+via `npx` or from a source checkout it only prints a one-line notice. If the
+API's *minimum* is not met, the command stops with the exact fix instead of
+failing later on a changed wire contract.
+
+- `inquir upgrade` - update now (`--check` only reports).
+- Opt out: `inquir config set autoUpdate false`, `INQUIR_NO_AUTO_UPDATE=1`, or `--no-update` on one command.
+
 **Diagnostics & config**
 
 - `inquir doctor` - diagnose environment, credentials, and API connectivity (`--json` for a report).
@@ -333,6 +407,6 @@ Tips:
 - After publishing, anyone can install and deploy:
 
 ```bash
-npm install -g @inquir/compute-cli
+npm install -g @inquir/compute-cli@latest
 inquir --help
 ```

package/dist/commands/apps.d.ts

@@ -0,0 +1,21 @@
+import { type AppPortSpec, type AppRuntimeSpec, type Release } from '../utils/api.js';
+export declare function appsCommand(args: string[]): Promise<void>;
+/**
+ * `--tcp name:port[:public][:hostPort]` — the shorthand people actually want
+ * to type for a database or SSH endpoint.
+ */
+export declare function parseTcpPortFlag(value: string): AppPortSpec;
+export declare function parseSetFlags(values: string[]): Record<string, string>;
+/** Runtime spec assembled from flags; undefined when nothing was specified. */
+export declare function buildRuntimeFromFlags(args: string[]): AppRuntimeSpec | undefined;
+/**
+ * Where a client can actually connect. Public endpoints first; a host-local
+ * port is still printed (marked as such) because on an installation with no
+ * public hostname it is the only way in.
+ */
+export declare function releaseEndpointLines(release: Release, previewUrl?: string, options?: {
+    includeHostLocal?: boolean;
+}): string[];
+/** A build-sourced release is best named by its build; a pulled one by its ref. */
+export declare function describeImage(release: Pick<Release, 'imageSource' | 'buildId' | 'imageRef' | 'imageDigest'>): string;
+//# sourceMappingURL=apps.d.ts.map

package/dist/commands/apps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../../src/commands/apps.ts"],"names":[],"mappings":"AAEA,OAAO,EAyBL,KAAK,WAAW,EAChB,KAAK,cAAc,EAGnB,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAC;AAgCzB,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA8C/D;AAqDD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CA6B3D;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAUtE;AAED,+EAA+E;AAC/E,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,GAAG,SAAS,CAuChF;AA+PD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,GAAE;IAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAAO,GAC3C,MAAM,EAAE,CAwBV;AAED,mFAAmF;AACnF,wBAAgB,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC,GAAG,MAAM,CAGpH"}