@inference/cli 0.0.8 → 0.0.9-beta.20

package/README.md

@@ -46,7 +46,7 @@ inf project list
 inf project switch <project-id>
 
 # Instrument a codebase with observability (run from your project directory)
-inf install
+inf instrument
 
 # View recent training runs
 inf training list
@@ -63,7 +63,7 @@ inf dashboard
 inf auth login          # Sign in via browser (device authorization flow)
 inf auth logout         # Sign out and clear stored credentials
 inf auth status         # Show current authentication status
-inf auth set-key <key>  # Set an API key for CI/headless use (sk-observability-*)
+inf auth set-key <key>  # Set an API key for CI/headless use
 ```
 
 ### Projects
@@ -74,11 +74,11 @@ inf project switch <id> # Set the active project
 inf project current     # Show the currently active project
 ```
 
-### Install (Automated Observability Setup)
+### Instrument (Automated Observability Setup)
 
 ```bash
-inf install             # Instrument your codebase with Catalyst observability
-inf install --dry-run   # Preview changes without modifying files
+inf instrument             # Instrument your codebase with Catalyst observability
+inf instrument --dry-run   # Preview changes without modifying files
 ```
 
 Automatically instruments your codebase to route LLM API calls through the Inference.net observability proxy. The command:
@@ -149,13 +149,13 @@ Stored at `~/.inf/config.json`. Managed automatically by `inf auth` commands.
 
 ### Environment Variables
 
-| Variable         | Description                   | Default                                   |
-| ---------------- | ----------------------------- | ----------------------------------------- |
-| `INF_API_URL`    | LLM Ops API base URL          | `https://observability-api.inference.net` |
-| `INF_AUTH_URL`   | Auth server base URL          | Derived from API URL                      |
-| `INF_UI_URL`     | Web app URL (for device auth) | Derived from API URL                      |
-| `INF_API_KEY`    | API key for headless/CI auth  |                                           |
-| `INF_PROJECT_ID` | Override active project ID    |                                           |
+| Variable         | Description                                                           | Default                                   |
+| ---------------- | --------------------------------------------------------------------- | ----------------------------------------- |
+| `INF_API_URL`    | LLM Ops API base URL                                                  | `https://observability-api.inference.net` |
+| `INF_AUTH_URL`   | Auth server base URL                                                  | Derived from API URL                      |
+| `INF_UI_URL`     | Web app URL (for device auth)                                         | Derived from API URL                      |
+| `INF_API_KEY`    | Scoped platform key for headless/CI auth                              |                                           |
+| `INF_PROJECT_ID` | Override the selected project when a key can access multiple projects |                                           |
 
 ### Priority Order
 
@@ -177,18 +177,94 @@ For CI pipelines and automated environments where browser-based login is not pos
 
 ```bash
 # Set your API key (obtain from Inference.net dashboard under project settings)
-export INF_API_KEY=sk-observability-...
+# New keys use the sk-inference-* prefix. Existing sk-observability-* keys still work.
+export INF_API_KEY=sk-inference-...
 
 # Or persist it in the config file
-inf auth set-key sk-observability-...
+inf auth set-key sk-inference-...
 
-# Set the project
+# Set the project when the key is scoped to multiple projects.
+# Single-project keys or keys with a default project can omit this.
 export INF_PROJECT_ID=your-project-id
 
 # Now all commands work without interactive login
 inf training list --json
 ```
 
+## Release Workflow
+
+INF-CLI is published to npm entirely through GitHub Actions.
+
+- Workflow: `.github/workflows/inference--inf-cli-release.yml`
+- Packages published together:
+  - `@inference/cli`
+  - `@inference/cli-darwin-arm64`
+  - `@inference/cli-darwin-x64`
+  - `@inference/cli-linux-x64`
+  - `@inference/cli-linux-arm64`
+- Version source of truth: `inference/apps/inf-cli/package.json`
+- The checked-in version must always be a stable semver like `0.0.9`
+- Do not commit prerelease versions like `0.0.9-beta.3` to git
+
+### Branch Mapping
+
+| Branch        | Environment | Published Version Format | npm Dist-Tag |
+| ------------- | ----------- | ------------------------ | ------------ |
+| `development` | Beta        | `0.0.9-beta.<run>`       | `beta`       |
+| `main`        | Stable      | `0.0.9`                  | `latest`     |
+
+Developers publish across environments by moving the same stable base version through `development` first, then `main`.
+
+### What The Workflow Does
+
+On a qualifying push or manual dispatch, the workflow:
+
+1. Validates that the run is on `development` or `main`
+2. Reads the stable base version from `apps/inf-cli/package.json`
+3. Computes the publish version for the target environment
+4. Runs INF-CLI unit tests and `bun tsc --noEmit`
+5. Builds the umbrella CLI plus all four platform binaries
+6. Creates a staged publish artifact and rewrites package versions only inside staging
+7. Validates each staged package with `npm pack --dry-run`
+8. Publishes platform packages first and `@inference/cli` last
+9. Retries npm verification until the expected version and dist-tag are visible
+
+The workflow can also repair a partial stable release. If `@inference/cli` already exists on npm but one of the platform packages is missing, rerunning the workflow on the same stable version will publish only the missing packages.
+
+### Releasing A New Version
+
+1. Choose the next stable version.
+2. Sync all committed CLI manifests to that version.
+
+```bash
+cd inference/apps/inf-cli
+bun scripts/sync-versions.ts 0.0.9
+```
+
+3. Commit the manifest changes.
+4. Merge or push that version to `development` to start the beta train.
+5. Validate the beta release from npm using the `beta` dist-tag.
+6. Merge the same version to `main` to publish the stable release to `latest`.
+
+### Manual Runs
+
+- `workflow_dispatch` is intended for dry runs and emergency re-publishes
+- Set `dry_run=true` to validate the full build and packaging path without publishing to npm
+- Set `dry_run=false` only on `development` or `main`
+- Manual runs from other branches are rejected by the workflow
+
+### Local Release Preview
+
+If you want to verify the compiled CLI version locally without changing committed manifests, you can inject a temporary build version:
+
+```bash
+cd inference/apps/inf-cli
+INFERENCE_CLI_BUILD_VERSION=0.0.9-beta.local bun run build:npm:all
+./bin/inf --version
+```
+
+This is useful for previewing beta-style binaries before the GitHub Actions workflow publishes them.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inference/cli",
-  "version": "0.0.8",
+  "version": "0.0.9-beta.20",
   "description": "Inference.net CLI - manage training runs, evals, datasets, and inferences from your terminal",
   "type": "module",
   "license": "MIT",
@@ -26,20 +26,21 @@
     "ai"
   ],
   "optionalDependencies": {
-    "@inference/cli-darwin-arm64": "0.0.8",
-    "@inference/cli-darwin-x64": "0.0.8",
-    "@inference/cli-linux-x64": "0.0.8",
-    "@inference/cli-linux-arm64": "0.0.8"
+    "@inference/cli-darwin-arm64": "0.0.9-beta.20",
+    "@inference/cli-darwin-x64": "0.0.9-beta.20",
+    "@inference/cli-linux-x64": "0.0.9-beta.20",
+    "@inference/cli-linux-arm64": "0.0.9-beta.20"
   },
   "scripts": {
     "build": "bun run clean:bin && bun run build:cli",
-    "build:cli": "bun build src/index.ts --compile --minify --outfile bin/inf",
-    "build:cli:local": "bun build src/index.ts --compile --outfile bin/inf",
-    "build:npm:darwin-arm64": "bun build src/index.ts --bundle --compile --minify --external '@opentui/core-*' --target=bun-darwin-arm64 --outfile npm/cli-darwin-arm64/bin/inf",
-    "build:npm:darwin-x64": "bun build src/index.ts --bundle --compile --minify --external '@opentui/core-*' --target=bun-darwin-x64 --outfile npm/cli-darwin-x64/bin/inf",
-    "build:npm:linux-x64": "bun build src/index.ts --bundle --compile --minify --external '@opentui/core-*' --target=bun-linux-x64 --outfile npm/cli-linux-x64/bin/inf",
-    "build:npm:linux-arm64": "bun build src/index.ts --bundle --compile --minify --external '@opentui/core-*' --target=bun-linux-arm64 --outfile npm/cli-linux-arm64/bin/inf",
-    "build:npm:all": "bun run clean:npm && bun run build:npm:darwin-arm64 && bun run build:npm:darwin-x64 && bun run build:npm:linux-x64 && bun run build:npm:linux-arm64",
+    "build:cli": "bun build src/index.ts --compile --minify --env=INFERENCE_CLI_* --outfile bin/inf",
+    "build:cli:local": "bun build src/index.ts --compile --env=INFERENCE_CLI_* --outfile bin/inf",
+    "prepare:npm:manifests": "bun scripts/sync-versions.ts",
+    "build:npm:darwin-arm64": "bun build src/index.ts --bundle --compile --minify --env=INFERENCE_CLI_* --external '@opentui/core-*' --target=bun-darwin-arm64 --outfile npm/cli-darwin-arm64/bin/inf",
+    "build:npm:darwin-x64": "bun build src/index.ts --bundle --compile --minify --env=INFERENCE_CLI_* --external '@opentui/core-*' --target=bun-darwin-x64 --outfile npm/cli-darwin-x64/bin/inf",
+    "build:npm:linux-x64": "bun build src/index.ts --bundle --compile --minify --env=INFERENCE_CLI_* --external '@opentui/core-*' --target=bun-linux-x64 --outfile npm/cli-linux-x64/bin/inf",
+    "build:npm:linux-arm64": "bun build src/index.ts --bundle --compile --minify --env=INFERENCE_CLI_* --external '@opentui/core-*' --target=bun-linux-arm64 --outfile npm/cli-linux-arm64/bin/inf",
+    "build:npm:all": "bun run clean:npm && bun run build && bun run build:npm:darwin-arm64 && bun run build:npm:darwin-x64 && bun run build:npm:linux-x64 && bun run build:npm:linux-arm64",
     "clean:bin": "rm -rf bin/inf",
     "clean:npm": "rm -f npm/cli-darwin-arm64/bin/inf npm/cli-darwin-x64/bin/inf npm/cli-linux-x64/bin/inf npm/cli-linux-arm64/bin/inf",
     "dev": "bun src/index.ts",
@@ -50,23 +51,5 @@
     "tsc": "tsc",
     "test": "bun run test:unit",
     "test:unit": "bun test ./tests/unit"
-  },
-  "devDependencies": {
-    "@inference-net/cf-compatible-models": "workspace:*",
-    "@inference-net/cf-compatible-utils": "workspace:*",
-    "@inference-net/llm-ops-trpc-api": "workspace:*",
-    "@opentui/core": "0.1.80",
-    "@opentui/react": "0.1.80",
-    "@trpc/client": "11.4.0",
-    "@trpc/server": "11.4.0",
-    "@inquirer/confirm": "5.1.21",
-    "@inquirer/select": "4.4.2",
-    "@types/bun": "1.3.6",
-    "chalk": "5.4.1",
-    "cli-table3": "0.6.5",
-    "commander": "13.1.0",
-    "open": "10.1.0",
-    "ora": "8.2.0",
-    "typescript": "5"
   }
 }