Skip to content

Add documentation for new migrate Cloudflare CLI command #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dario-piotrowicz wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add documentation for new migrate Cloudflare CLI command #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 20 additions & 1 deletion pages/cloudflare/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Cloudflare adapter provides a `opennextjs-cloudflare` CLI to develop, build,

`opennextjs-cloudflare` support multiple commands, invoked via `opennextjs-cloudflare <command>`.

The currently supported commands are `build`, `populateCache`, `preview`, `deploy`, and `upload`.
The currently supported commands are `build`, `populateCache`, `preview`, `deploy`, `upload`, and `migrate`.

You can list the commands by invoking `pnpm opennextjs-cloudflare` and get help with a given command by invoking `pnpm opennextjs-cloudflare <command> --help`.

Expand Down Expand Up @@ -47,3 +47,22 @@ It starts by populating the remote cache and then deploys your application to Cl
### `upload` command

It starts by populating the remote cache and then uploads a version of your application to Cloudflare (via `wrangler upload`). Note that the application will not automatically be served on uploads. See [Gradual deployments](https://developers.cloudflare.com/workers/configuration/versions-and-deployments/gradual-deployments/) to learn more about how to serve an uploaded version.

### `migrate` command

Converts a standard Next.js project into an OpenNext-compatible one. This command automates the setup steps described in the [Get Started guide](/cloudflare/get-started#existing-nextjs-apps), including:

- Installing required dependencies (`@opennextjs/cloudflare` and `wrangler`)
- Creating a `wrangler.jsonc` configuration file
- Creating an `open-next.config.ts` file
- Adding a `.dev.vars` file
- Updating the `package.json` scripts
- Adding static asset caching headers (`public/_headers`)
- Adding `.open-next` to `.gitignore`
- Setting up local development with `initOpenNextCloudflareForDev()` in your Next.js config

Run the command in your existing Next.js project:

```sh
npx @opennextjs/cloudflare migrate
```
10 changes: 10 additions & 0 deletions pages/cloudflare/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ npm create cloudflare@latest -- my-next-app --framework=next --platform=workers

#### Existing Next.js apps

The easiest way to convert an existing Next.js app is to use the `migrate` command:

```sh
npx @opennextjs/cloudflare migrate
```

This command automates all the setup steps below. See the [CLI documentation](/cloudflare/cli#migrate-command) for more details.

Alternatively, you can follow the manual steps below.

##### 1. Install @opennextjs/cloudflare

First, install [@opennextjs/cloudflare](https://www.npmjs.com/package/@opennextjs/cloudflare):
Expand Down