elm-github-install

elm-install

This gem allows you to install Elm packages directly from any Git repository (even private ones), bypassing the package repository (package.elm-lang.org) while also enabling restricted (effect manager and native) packages to be installed.

Installation

If you have ruby installed on your machine then you can install it directy from rubygems.org:

gem install elm_install

If you have npm installed on your machine then you can install it directly from npm:

npm install elm-github-install -g

There are also dependency free versions available for every release in the releases page.

Basic Usage

Once installed elm-install can be used instead of elm-package as a replacement:

elm-package.json:

{
  ...
  "dependencies": {
    "elm-lang/core": "5.0.0 <= v < 6.0.0",
    "elm-lang/svg": "2.0.0 <= v < 3.0.0",
    "elm-lang/dom": "1.1.1 <= v < 2.0.0"
  }
  ...
}

Command:

$ elm-install

Resolving packages...
  ▶ Package: https://github.com/elm-lang/core not found in cache, cloning...
  ▶ Package: https://github.com/elm-lang/svg not found in cache, cloning...
  ▶ Package: https://github.com/elm-lang/html not found in cache, cloning...
  ▶ Package: https://github.com/elm-lang/virtual-dom not found in cache, cloning...
  ▶ Package: https://github.com/elm-lang/dom not found in cache, cloning...
Solving dependencies...
Saving package cache...
  ● elm-lang/core - 5.0.0 (5.0.0)
  ● elm-lang/svg - 2.0.0 (2.0.0)
  ● elm-lang/dom - 1.1.1 (1.1.1)
  ● elm-lang/html - 2.0.0 (2.0.0)
  ● elm-lang/virtual-dom - 2.0.3 (2.0.3)
Packages configured successfully!

Advanced Usage

Sources (urls for git repositories) can be defined in the dependency-sources field in elm-package.json for any package defined in the dependencies field. There is only one restriction: the pacakges name must match the path of the url of the git repository, this is because it could cause conflicts with other packages and with native code.

The source can be defined by a string (url) or a hash containing the url and the reference (tag, commit hash, branch) to use. If a reference is defined then the version in the dependencies field is ignored and the version will be used from the elm-package.json at that reference.

  ...
  "dependencies": {
    "gdotdesign/elm-install-test": "1.0.0 <= v < 2.0.0",
    "elm-lang/core": "5.0.0 <= v < 6.0.0",
    "elm-lang/svg": "2.0.0 <= v < 3.0.0",
    "elm-lang/dom": "1.1.1 <= v < 2.0.0"
  },
  "dependency-sources": {
    "elm-lang/core": "[e-mail]:elm-lang/core",
    "gdotdesign/elm-install-test": {
      "url": "[e-mail]:gdotdesign/elm-install-test",
      "ref": "master"
    }
  }
  ...

FAQ

Do I need to use SSH keys?

It dependes on your use case, but for public repositories in Github or Bitbucket it's not needed.

What url protocols are supported?

The following protocols can be used:

• ssh://[user@]host.xz[:port]/path/to/repo.git/
• git://host.xz[:port]/path/to/repo.git/
• http[s]://host.xz[:port]/path/to/repo.git/
• [user@]host.xz:path/to/repo.git/

Can I install from private repositories?

Yes private repositories are supported provided you have authentication (for example SSH keys).

How is it work exactly?

You can read more about it [here](docs/How it works.md).