luxx v0.0.1

luxx

This is a tool for downloading, installing, and updating GitHub and NPM projects.

⚠️ Note: This library is still in alpha, expect breaking changes.

Usage

import createLuxx from 'luxx'

const luxx = createLuxx({
  installPath: process.cwd(),
})

luxx
  .installGitHub({
    owner: 'mmmurray',
    repo: 'luxx',
  })
  .then(() => {
    console.log('Installed.')
  })

You must have git installed and configured to download over SSH. If you do not want to use the default SSH key, you can create a custom SSH key pair and add the private key to <installPath>/ssh/id_rsa. Make sure to add the public key as a deploy key to the GitHub repo you wish to clone. See https://developer.github.com/v3/guides/managing-deploy-keys/#setup-2 for more information.