@avsbhq/cli 3.8.1 → 3.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AvsB Platform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -119,7 +119,7 @@ avsb codegen                     # inside a cloned or pulled folder
 
 ## Commands
 
-Every command group the CLI ships. All of them need a token already in place (see Authentication) except `avsb login`, which supplies one, plus `avsb logout`, `avsb status` and `avsb agents-md`, which only touch local files.
+Every command group the CLI ships. All of them need a token already in place (see Authentication) except `avsb login`, which supplies one, plus `avsb logout`, `avsb status` and `avsb agents-md`, which only touch local files, and `avsb completion`, which only prints a script.
 
 ### Setup
 
@@ -152,7 +152,7 @@ Personal access tokens belong to a user, not to one organization, so a single to
 | `avsb status` | Show what the local manifest says about this experiment |
 | `avsb dev` | Watch local files and hot reload through the Chrome extension |
 | `avsb pull` | Overwrite local files with the platform's current code. `-f, --force` |
-| `avsb push` | Compile and upload local code. `-f, --force` |
+| `avsb push` | Compile and upload local code. `-f, --force`, `--publish`, `--no-publish` |
 
 ### Project scripts
 
@@ -204,7 +204,7 @@ Tracking definitions: what counts as a click, a pageview, or a custom event.
 | `avsb metrics unarchive <metricId>` | Restore an archived metric |
 | `avsb metrics delete <metricId>` | Delete a metric. Refused while metric bindings reference it. `-f, --force` |
 
-Every metrics command accepts `--project <PRJ-42 or 42>`, and falls back to the project in the local manifest when you are inside a cloned folder.
+Every metrics command accepts `--project <PRJ-42 or 42>`, and falls back to the project in the local manifest when you are inside a cloned folder. A `<metricId>` can be `MET-17`, `17`, or the long ID.
 
 ### Metric bindings
 
@@ -213,8 +213,8 @@ Analysis-side wrappers: how a metric is measured in an experiment.
 | Command | Description |
 | ------- | ----------- |
 | `avsb metric-bindings list` | List bindings. `--library`, `--search <text>`, `--include-archived`, `--limit <n>` |
-| `avsb metric-bindings create` | Create a binding. `--measure`, `--direction`, `--name`, `--description`, `--metric`, `--numerator-metric`, `--denominator-metric`, `--composition <json>`, `--component <metricId:weight>`, `--percentile`, `--value-source`, `--winsorize-upper`, `--winsorize-lower` |
-| `avsb metric-bindings update <id>` | Update a binding. Same flags, plus `--library` / `--no-library` |
+| `avsb metric-bindings create` | Create a binding. `--measure`, `--direction`, `--name`, `--description`, `--metric`, `--numerator-metric`, `--denominator-metric`, `--composition <json>`, `--component <bindingId:weight>`, `--percentile`, `--value-source`, `--winsorize-upper`, `--winsorize-lower` |
+| `avsb metric-bindings update <id>` | Update a binding (`MBD-8`, `8`, or the long ID). Same flags, plus `--library` / `--no-library` |
 | `avsb metric-bindings archive <id>` | Archive a binding |
 | `avsb metric-bindings unarchive <id>` | Restore an archived binding |
 | `avsb metric-bindings delete <id>` | Delete a binding. Refused while experiments attach it. `-f, --force` |
@@ -234,12 +234,20 @@ Measures: `UNIQUE_CONVERSIONS_PER_VISITOR`, `TOTAL_EVENTS`, `UNIQUE_VISITORS_WHO
 
 | Command | Description |
 | ------- | ----------- |
-| `avsb codegen` | Generate TypeScript types from a published datafile. `-p, --project <project>` (defaults to the local manifest), `-e, --env <key>` (default `production`), `-o, --output <path>` (default `./src/generated/flags.ts`) |
+| `avsb codegen` | Generate TypeScript types from a published datafile. `-p, --project <project>` (defaults to the local manifest), `-e, --env <key>` (default `production`), `-o, --output <path>` (default `./src/generated/flags.ts`), `-m, --manifest <path>`, `--no-augment`, `--check`, `--watch`, `--interval <seconds>` |
+| `avsb find-refs` | Find flag keys in your source and compare them with the platform. `-p, --project <project>`, `-d, --dir <path>`, `-i, --ignore <pattern>`, `--max-files <count>`, `--strict`, `--json` |
 
 The generated file declares `FlagKey` (a union of your flag keys), `FlagValues` (booleans, numbers, string-literal unions, and `unknown` for JSON flags, which you narrow yourself), and `ContextSchema` (one entry per context kind, each with `key: string` plus your registered attributes).
 
 `--project` accepts `PRJ-42`, `42`, or a dashboard URL. Inside a folder created by `avsb project pull` or `avsb clone`, leave it out: the project comes from `.avsb-project.json`, then `.avsb.json`, and the run says which file it read.
 
+### Webhooks
+
+| Command | Description |
+| ------- | ----------- |
+| `avsb listen` | Watch this project's webhook deliveries and forward a copy to a local URL. `--project <project>`, `--forward <url>` (must start with `http://` or `https://`, anything else exits 2), `--print-secret-hint` |
+| `avsb trigger [event]` | Send a sample webhook event to this project's webhooks. `--project <project>`, `--webhook <id>`, `--list` |
+
 ## Output for scripts
 
 Every read command takes `--json` and prints exactly one document on stdout:
@@ -294,11 +302,12 @@ Press `Ctrl+C` to stop.
 
 Compiles your TypeScript and SCSS locally, then uploads the source and the compiled output. Compile errors are reported with file, line, and column, and nothing is uploaded until they are fixed.
 
-Before uploading, the CLI hashes the platform's copy and warns you if it changed since your last sync. When the experiment is running, it offers to publish the change immediately.
+Before uploading, the CLI hashes the platform's copy and warns you if it changed since your last sync. When the experiment is running or paused, it offers to publish the change immediately; `--publish` and `--no-publish` answer that question up front, which is what a CI job wants.
 
 ```bash
 avsb push
 avsb push --force   # skip the remote-change check
+avsb push --publish # publish without the question
 ```
 
 ### Pull
@@ -338,7 +347,7 @@ project-10/
   avsb.d.ts               # type definitions for the avsb API, TypeScript projects only
 ```
 
-Re-running `project pull` in an existing folder updates the local file.
+Re-running `project pull` updates the existing folder in place, whether you run it from inside `project-<id>/` or from the folder that holds it; it never creates a nested copy. If your local script has edits it asks first, and `--force` overwrites them without asking.
 
 ## Cloned experiment structure