cf 0.9.1 → 0.11.0

package/README.md

@@ -1,8 +1,8 @@
 # cf
 
-A unified command-line interface for Cloudflare.
+A unified command-line interface for Cloudflare, generated from Cloudflare's public OpenAPI surface and published as the unscoped `cf` npm package.
 
-This is a technical preview. To learn more, see the [announcement blogpost](http://blog.cloudflare.com/cf-cli-local-explorer).
+This is a technical preview. To learn more, see the [announcement blog post](https://blog.cloudflare.com/cf-cli-local-explorer/).
 
 ## Install
 
@@ -23,6 +23,8 @@ cf <command> --help  # Per-command help
 cf complete bash >> ~/.bashrc   # Install shell completions
 ```
 
+Generated API commands follow the shape `cf <product> [group…] <operation>`. Use help or shell completion to discover the current surface; it changes with the pinned public OpenAPI release.
+
 ## Authentication
 
 cf resolves credentials in this order:
@@ -34,11 +36,24 @@ cf resolves credentials in this order:
 Use `cf auth create`, `delete`, `activate`, `deactivate`, and `list` to manage
 named profiles. `cf auth login` and `cf auth logout` manage the default profile.
 
+## Projects
+
+`cf dev` and `cf build` detect supported projects, run autoconfiguration when needed, and invoke the canonical framework command or an installed Cloudflare implementation. Successful builds produce standardized Build Output.
+
+`cf deploy` builds by default and then uploads that output. `cf workers versions create` uploads a version without deploying it, and `cf workers triggers deploy` applies the configured routes and cron schedules. Pass `--prebuilt` to any of these commands to reuse existing Build Output.
+
+## Local resources
+
+Add `--local` to a supported command to run it against a short-lived Miniflare instance backed by cf's persisted local state. Cold-state support includes KV key get/list/update/delete and bulk get, D1 raw plus D1 migration list/apply, and R2 object get/upload/list and array-body bulk delete. Some Durable Object and Workflow operations additionally require a compatible live registry peer that advertises their bindings. Use `--persist-to <directory>` to select a different state directory; it is valid only with `--local`. Commands with no local explorer equivalent return an error instead of falling through to production.
+
 ## Output
 
-All output is JSON, written to stdout. Status messages (spinners, success
-markers) go to stderr. Pipe through `jq` for newline-delimited or
-filtered output.
+Structured API results are pretty-printed JSON on stdout. Generated `binary` and `text` response kinds instead write their payload directly to stdout, preserving binary output for redirection; some binary commands provide `--text` for UTF-8 decoding. Null-result success markers go to stderr. On an interactive, color-capable TTY, clack progress animation uses stdout before the final payload; it is disabled for pipes, color-disabled terminals, or `CF_QUIET=1`. Pipe JSON results through `jq` for newline-delimited or filtered output.
+
+Supported terminals also show progress outside the terminal buffer, such as in
+the tab title or OS taskbar. Set `CF_NO_OSC_PROGRESS=1` to disable this globally.
+Set `CF_FORCE_OSC_PROGRESS=1` to enable it for an unrecognized compatible
+terminal.
 
 ## Documentation