|
1 | 1 | # @bigcommerce/catalyst |
2 | 2 |
|
| 3 | +## 1.0.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- [#3077](https://github.com/bigcommerce/catalyst/pull/3077) [`a45ab43`](https://github.com/bigcommerce/catalyst/commit/a45ab4346c27e8cc60d6ce64fb597f22dbde2243) Thanks [@jorgemoya](https://github.com/jorgemoya)! - Introducing the Catalyst CLI (`@bigcommerce/catalyst`) — a single command-line tool for scaffolding, building, and deploying your Catalyst storefront to BigCommerce's Native Hosting infrastructure. |
| 8 | + |
| 9 | + ### Highlights |
| 10 | + - **Scaffold a storefront** — `catalyst create` downloads a clean, standalone project (flattened from `core/`, `workspace:` dependencies resolved to published versions, fresh git repo) via tarball extraction and connects it to your BigCommerce store. The package manager is auto-detected from `npm_config_user_agent`. |
| 11 | + - **Browser-based authentication** — Run `catalyst auth login` to authenticate via an OAuth device code flow. Credentials are stored locally in `.bigcommerce/project.json` for use by all subsequent commands. CI/CD environments can use `--store-hash` and `--access-token` flags or environment variables instead. |
| 12 | + - **Project & channel management** — Create, link, and list BigCommerce infrastructure projects with `catalyst project`, and connect storefront channels with `catalyst channel`. |
| 13 | + - **Build & deploy** — `catalyst build` runs the OpenNext Cloudflare build pipeline (deriving the Wrangler `compatibility_date` dynamically) and generates deployment artifacts. `catalyst deploy` bundles, uploads, and deploys your storefront with real-time progress streaming. Pass runtime secrets with `--secret KEY=VALUE`; environment variables are auto-detected as deploy secrets. |
| 14 | + - **Persisted deployment env vars** — Manage deployment environment variables across deploys with `catalyst env` (list and remove; values are masked). |
| 15 | + - **Custom domains** — Add, list, check the status of, and remove custom domains for a Native Hosting project with `catalyst domains`. |
| 16 | + - **Local preview** — `catalyst start` launches a local Cloudflare Workers preview of your built storefront via the OpenNext adapter. |
| 17 | + - **Live & historical logs** — `catalyst logs tail` streams real-time application logs with color-coded levels and auto-reconnect; `catalyst logs query` retrieves historical logs. |
| 18 | + - **In-place upgrades** — `catalyst upgrade` upgrades a project to a newer version via a resilient 3-way merge (`git merge-tree`, falling back to per-file `git merge-file`), producing resolvable conflict markers instead of ever aborting. |
| 19 | + - **Smart credential resolution** — Configuration is resolved in priority order: CLI flags → `--env-file` → process environment variables → `.bigcommerce/project.json`. |
| 20 | + - **Telemetry** — Anonymous usage telemetry with session and correlation IDs for support. Opt out anytime with `catalyst telemetry disable`. |
| 21 | + |
| 22 | + ### Commands |
| 23 | + |
| 24 | + | Command | Description | |
| 25 | + | -------------------- | -------------------------------------------------------------------- | |
| 26 | + | `catalyst create` | Scaffold and connect a Catalyst storefront to your BigCommerce store | |
| 27 | + | `catalyst auth` | Authenticate, sign out, and verify stored credentials | |
| 28 | + | `catalyst project` | Create, link, and list infrastructure projects | |
| 29 | + | `catalyst channel` | Connect a storefront channel to your project | |
| 30 | + | `catalyst build` | Build your Catalyst project for deployment | |
| 31 | + | `catalyst deploy` | Build and deploy to BigCommerce Native Hosting | |
| 32 | + | `catalyst env` | Manage persisted deployment environment variables | |
| 33 | + | `catalyst domains` | Manage custom domains for a Native Hosting project | |
| 34 | + | `catalyst start` | Start a local Cloudflare Workers preview | |
| 35 | + | `catalyst logs` | Stream live logs and query historical logs | |
| 36 | + | `catalyst upgrade` | Upgrade a project to a newer version via 3-way merge | |
| 37 | + | `catalyst version` | Display CLI, Node.js, and platform info | |
| 38 | + | `catalyst telemetry` | View or change telemetry collection status | |
| 39 | + |
| 40 | + ### Getting started |
| 41 | + |
| 42 | + ```bash |
| 43 | + cd core |
| 44 | + pnpm add @bigcommerce/catalyst@latest @opennextjs/cloudflare@1.17.3 |
| 45 | + pnpm catalyst auth login |
| 46 | + pnpm catalyst project create |
| 47 | + pnpm catalyst deploy --secret BIGCOMMERCE_STORE_HASH=<hash> --secret BIGCOMMERCE_STOREFRONT_TOKEN=<token> |
| 48 | + ``` |
| 49 | + |
| 50 | + For full documentation, see the [Native Hosting Overview](https://developer.bigcommerce.com/docs/storefront/catalyst/deployment/native-hosting/overview) and [CLI Reference](https://developer.bigcommerce.com/docs/storefront/catalyst/reference/cli). |
| 51 | + |
3 | 52 | ## 1.0.0-alpha.6 |
4 | 53 |
|
5 | 54 | ### Patch Changes |
|
0 commit comments