Skip to content

The readme file does not document what template name options are #86

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.

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

Open
seanahrens opened this issue Feb 12, 2025 · 2 comments
Open

Comments

@seanahrens
Copy link

The readme shows the command to use with eg. <template_name> but doesn't say what the options are or where to learn what the options are.

@Tags-collab
Copy link

#86

@zoydburger
Copy link

zoydburger commented Apr 17, 2025

This is especially confusing, since the CLI only lists invalid (?) options?

create-react-router --help returns the following:


- a GitHub repo shorthand, :username/:repo or :username/:repo/:directory
- the URL of a GitHub repo (or directory within it)
- the URL of a tarball
- a file path to a directory of files
- a file path to a tarball

$ create-react-router my-app --template remix-run/react-router/templates/basic
$ create-react-router my-app --template remix-run/react-router/examples/basic
$ create-react-router my-app --template :username/:repo
$ create-react-router my-app --template :username/:repo/:directory
$ create-react-router my-app --template https://github.com/:username/:repo
$ create-react-router my-app --template https://github.com/:username/:repo/tree/:branch
$ create-react-router my-app --template https://github.com/:username/:repo/tree/:branch/:directory
$ create-react-router my-app --template https://github.com/:username/:repo/archive/refs/tags/:tag.tar.gz
$ create-react-router my-app --template https://example.com/template.tar.gz
$ create-react-router my-app --template ./path/to/template
$ create-react-router my-app --template ./path/to/template.tar.gz

The proposed template paths in README.md in this repo or provided by calling create-react-router --help don't work:


         create-react-router v7.5.0
      ◼  Directory: Using my-test as project directory

      ◼  Template: Using remix-run/react-router-templates/basic...
 ██████  Template copying...

      ▲  Oh no! The path "basic" was not found in this GitHub repo.

         create-react-router v7.5.0
      ◼  Directory: Using my-test as project directory

      ◼  Template: Using remix-run/react-router/templates/basic...
 ██████  Template copying...

      ▲  Oh no! The path "templates/basic" was not found in this GitHub repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants