cli

Command-line interface for creating and managing Remix projects.

Features

• Create new Remix projects with npx remix@next new or installed remix new
• Print shell completion scripts with remix completion
• Check project environment and Remix app conventions with remix doctor
• Create low-risk project and controller files with remix doctor --fix
• Inspect the current app route tree with remix routes
• Run project tests with remix test
• Print the current Remix version with remix version
• Use the same CLI through the remix package or the remix/cli API
• Scaffold a starter app that matches the Remix project layout conventions

Installation

Use npx remix@next new <target-dir> to scaffold a new Remix app. Install remix when you want the local remix command:

npm i remix

Shell completion

Install bash completion:

remix completion bash >> ~/.bashrc

Install zsh completion:

remix completion zsh >> ~/.zshrc

Usage

Use npx remix@next new my-remix-app to scaffold a new Remix app. After installing Remix, the equivalent local command is remix new my-remix-app.

The rest of the CLI is available through the installed remix command:

remix new my-remix-app
remix completion bash >> ~/.bashrc
remix doctor
remix doctor --fix
remix routes
remix routes --table
remix routes --table --no-headers
remix test
remix version
remix --no-color doctor

You can also run the CLI programmatically:

import { runRemix } from 'remix/cli'

await runRemix(['new', 'my-remix-app'])
await runRemix(['completion', 'bash'])
await runRemix(['doctor'])
await runRemix(['doctor', '--fix'])
await runRemix(['routes'])
await runRemix(['routes', '--table'])
await runRemix(['routes', '--table', '--no-headers'])
await runRemix(['test'])
await runRemix(['version'])

runRemix() returns the CLI exit code as a promise.

License

See LICENSE