Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions .changeset/catalyst-cli-1.0.0.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/ltrac-910-create-catalyst-thin-wrapper.md

This file was deleted.

22 changes: 0 additions & 22 deletions .changeset/pre.json

This file was deleted.

49 changes: 49 additions & 0 deletions packages/catalyst/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,54 @@
# @bigcommerce/catalyst

## 1.0.0

### Major Changes

- [#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.

### Highlights
- **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`.
- **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.
- **Project & channel management** — Create, link, and list BigCommerce infrastructure projects with `catalyst project`, and connect storefront channels with `catalyst channel`.
- **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.
- **Persisted deployment env vars** — Manage deployment environment variables across deploys with `catalyst env` (list and remove; values are masked).
- **Custom domains** — Add, list, check the status of, and remove custom domains for a Native Hosting project with `catalyst domains`.
- **Local preview** — `catalyst start` launches a local Cloudflare Workers preview of your built storefront via the OpenNext adapter.
- **Live & historical logs** — `catalyst logs tail` streams real-time application logs with color-coded levels and auto-reconnect; `catalyst logs query` retrieves historical logs.
- **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.
- **Smart credential resolution** — Configuration is resolved in priority order: CLI flags → `--env-file` → process environment variables → `.bigcommerce/project.json`.
- **Telemetry** — Anonymous usage telemetry with session and correlation IDs for support. Opt out anytime with `catalyst telemetry disable`.

### Commands

| Command | Description |
| -------------------- | -------------------------------------------------------------------- |
| `catalyst create` | Scaffold and connect a Catalyst storefront to your BigCommerce store |
| `catalyst auth` | Authenticate, sign out, and verify stored credentials |
| `catalyst project` | Create, link, and list infrastructure projects |
| `catalyst channel` | Connect a storefront channel to your project |
| `catalyst build` | Build your Catalyst project for deployment |
| `catalyst deploy` | Build and deploy to BigCommerce Native Hosting |
| `catalyst env` | Manage persisted deployment environment variables |
| `catalyst domains` | Manage custom domains for a Native Hosting project |
| `catalyst start` | Start a local Cloudflare Workers preview |
| `catalyst logs` | Stream live logs and query historical logs |
| `catalyst upgrade` | Upgrade a project to a newer version via 3-way merge |
| `catalyst version` | Display CLI, Node.js, and platform info |
| `catalyst telemetry` | View or change telemetry collection status |

### Getting started

```bash
cd core
pnpm add @bigcommerce/catalyst@latest @opennextjs/cloudflare@1.17.3
pnpm catalyst auth login
pnpm catalyst project create
pnpm catalyst deploy --secret BIGCOMMERCE_STORE_HASH=<hash> --secret BIGCOMMERCE_STOREFRONT_TOKEN=<token>
```

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).

## 1.0.0-alpha.6

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/catalyst/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bigcommerce/catalyst",
"version": "1.0.0-alpha.6",
"version": "1.0.0",
"type": "module",
"bin": {
"catalyst": "dist/cli.js"
Expand Down
11 changes: 11 additions & 0 deletions packages/create-catalyst/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Changelog

## 2.0.0

### Major Changes

- [#3077](https://github.com/bigcommerce/catalyst/pull/3077) [`a45ab43`](https://github.com/bigcommerce/catalyst/commit/a45ab4346c27e8cc60d6ce64fb597f22dbde2243) Thanks [@jorgemoya](https://github.com/jorgemoya)! - Reduce `create-catalyst` to a thin wrapper that delegates to `catalyst create`. `pnpm create catalyst` / `npx create-catalyst` still scaffold a project — now by invoking `@bigcommerce/catalyst` under the hood — so the scaffolding UX is unchanged. The standalone `init`, `integration`, and `telemetry` subcommands are removed; use `catalyst channel link` and `catalyst telemetry` from the consolidated CLI instead.

### Patch Changes

- Updated dependencies [[`a45ab43`](https://github.com/bigcommerce/catalyst/commit/a45ab4346c27e8cc60d6ce64fb597f22dbde2243)]:
- @bigcommerce/catalyst@1.0.0

## 1.1.0

### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/create-catalyst/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bigcommerce/create-catalyst",
"version": "1.1.0",
"version": "2.0.0",
"repository": {
"type": "git",
"url": "https://github.com/bigcommerce/catalyst",
Expand Down
Loading