`create-remix`

create-remix CLI は、新しい Remix プロジェクトを作成します。引数を渡さずにこのコマンドを実行すると、インタラクティブな CLI が起動し、新しいプロジェクトの構成と指定されたディレクトリへの設定が実行されます。

npx create-remix@latest

オプションとして、目的のディレクトリパスを引数として渡すことができます。

npx create-remix@latest <projectDir>

デフォルトのアプリケーションは、組み込みの Remix App Server を使用した TypeScript アプリです。異なる設定に基づいてアプリケーションを作成する場合は、--template フラグを使用できます。

npx create-remix@latest --template <templateUrl>

使用可能なコマンドとフラグの完全なリストを取得するには、次を実行します。

npx create-remix@latest --help

パッケージマネージャー

create-remix は、さまざまなパッケージマネージャーを使用して呼び出すこともできます。これにより、npm、Yarn、pnpm、Bun のいずれかを選択してインストールプロセスを管理できます。

npm create remix@latest <projectDir>
# または
yarn create remix@latest <projectDir>
# または
pnpm create remix@latest <projectDir>
# または
bunx create-remix@latest <projectDir>

`create-remix --template`

使用可能なテンプレートの詳細なガイドについては、テンプレートページを参照してください。

有効なテンプレートは次のとおりです。

GitHub リポジトリの略称 - :username/:repo または :username/:repo/:directory
GitHub リポジトリ（またはその中のディレクトリ）の URL - https://github.com/:username/:repo または https://github.com/:username/:repo/tree/:branch/:directory
- この形式では、ブランチ名（:branch）に / を含めることはできません。create-remix は、ブランチ名とディレクトリパスを区別することができないためです。
リモートの tarball の URL - https://example.com/remix-template.tar.gz
ファイルのディレクトリのローカルファイルパス - ./path/to/remix-template
tarball のローカルファイルパス - ./path/to/remix-template.tar.gz

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

`create-remix --overwrite`

create-remix は、テンプレートとアプリケーションを作成するディレクトリの間でファイルの衝突を検出すると、テンプレートのバージョンでそれらのファイルを上書きしても問題ないかどうかを確認するプロンプトを表示します。このプロンプトは、--overwrite CLI フラグを使用してスキップできます。

パッケージマネージャー
create-remix --template
create-remix --overwrite