Skip to content

The @nx/remix plugin provides various executors to help you create and configure remix projects within your Nx workspace. Below is a complete reference for all available executors and their options.

build

Build a Remix app.

Options

OptionTypeDescriptionDefault
outputPathstring [required]The output path of the generated files.
generateLockfilebooleanGenerate a lockfile (e.g. package-lock.json) that matches the workspace lockfile to ensure package versions match.false
generatePackageJsonbooleanGenerate package.json file in the output folder.false
includeDevDependenciesInPackageJsonbooleanInclude devDependencies in the generated package.json file. By default only production dependencies are included.false
skipOverridesbooleanDo not add a overrides and resolutions entries to the generated package.json file. Only works in conjunction with generatePackageJson option.
skipPackageManagerbooleanDo not add a packageManager entry to the generated package.json file. Only works in conjunction with generatePackageJson option.
sourcemapbooleanGenerate source maps for production.false

serve

Serve a Remix app.

Options

OptionTypeDescriptionDefault
commandstringCommand used to run your app server.
debugbooleanAttach a Node.js inspector.false
devServerPortnumberPort to start the dev server on.
manualbooleanEnable manual modefalse
portnumberSet PORT environment variable that can be used to serve the Remix application.4200
tlsCertstringPath to TLS certificate (cert.pem).
tlsKeystringPath to TLS key (key.pem).