Remix CLI

The Remix CLI comes from the @remix-run/dev package. It also includes the compiler. Make sure it is in your package.json devDependencies so it doesn't get deployed to your server.

To get a full list of available commands and flags, run:

npx @remix-run/dev -h

`remix create`

remix create will create a new Remix project. Without passing arguments, this command will launch an interactive CLI to configure the new project and set it up in a given directory. Optionally you can pass the desired directory path as an argument and a starter template with the --template flag.

remix create <projectDir>

`remix create --template`

A valid template can be:

a directory located in the templates folder of the Remix repository
a local file path to a directory of files
a local file path to a tarball
the name of a :username/:repo on GitHub
the URL of a remote tarball

remix create ./my-app --template fly
remix create ./my-app --template /path/to/remix-template
remix create ./my-app --template /path/to/remix-template.tar.gz
remix create ./my-app --template remix-run/grunge-stack
remix create ./my-app --template :username/:repo
remix create ./my-app --template https://github.com/:username/:repo
remix create ./my-app --template https://github.com/:username/:repo/tree/:branch
remix create ./my-app --template https://github.com/:username/:repo/archive/refs/tags/:tag.tar.gz
remix create ./my-app --template https://github.com/:username/:repo/releases/latest/download/:tag.tar.gz
remix create ./my-app --template https://example.com/remix-template.tar.gz

`remix build`

Builds your app for production. This command will set process.env.NODE_ENV to production and minify the output for deployment.

remix build

`remix build --sourcemap`

Generates sourcemaps for the production build.

`remix watch`

Watches your application files and builds your app for development when changes are made.

remix watch

`remix dev`

The same as watch, but also boots the Remix App Server in development mode if it's installed.

remix dev

`remix dev --debug`

Attaches a Node inspector to develop your app in debug mode.

`remix dev --port`

Launches the app server on a given port.

By default, the port is set to 3000. If port 3000 is unavailable, the dev command will attempt to find another port that is open. Using the --port flag will only attempt to launch the server at the given port; if the port is unavailable, the app will not start.

remix dev --port 4001

Alternatively, a port can be assigned to the PORT environment variable.