search

elm / compiler

Compiler for Elm, a functional language for reliable webapps.
https://elm-lang.org/
BSD 3-Clause "New" or "Revised" License
7.56k stars 662 forks source link

"Install What": Misleading help when running `elm install` #1782

Open Qqwy opened 6 years ago

Qqwy commented 6 years ago

When running plain elm install, you get an "Install What" error message.

However, elm install --help will show you that both elm install <package name> and plain elm install are proper usages of the command. So I think that help text needs to be fixed:


$ elm install --help
The `install` command fetches packages from <https://package.elm-lang.org> for
use in your project:

    elm install
    elm install <package>

For example, if you want to get packages for HTTP and JSON, you would say:

    elm install elm/http
    elm install elm/json

Notice that you must say the AUTHOR name and PROJECT name! After running those
commands, you could say `import Http` or `import Json.Decode` in your code.

What if two projects use different versions of the same package? No problem!
Each project is independent, so there cannot be conflicts like that!
holgerl commented 5 years ago

This is very confusing. In many places it is also said that elm install is the new elm-package install, but it is clearly not