https://github.com/purescript/psc-package

A package manager for PureScript based on package sets
https://github.com/purescript/psc-package

package-manager purescript

Last synced: 13 days ago
JSON representation

A package manager for PureScript based on package sets

• Host: GitHub
• URL: https://github.com/purescript/psc-package
• Owner: purescript
• License: other
• Created: 2017-02-07T03:47:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-07-24T14:21:16.000Z (over 2 years ago)
• Last Synced: 2024-04-14T04:19:44.472Z (7 months ago)
• Topics: package-manager, purescript
• Language: Haskell
• Homepage: https://psc-package.readthedocs.io
• Size: 135 KB
• Stars: 227
• Watchers: 15
• Forks: 46
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-purescript - psc-package
• awesome-purescript - psc-package - A package manager for PureScript based on package sets (Build Tooling)

README

        
# `psc-package`

[![Build Status](https://travis-ci.org/purescript/psc-package.svg?branch=master)](https://travis-ci.org/purescript/psc-package)

`psc-package` is an executable which helps manage PureScript dependencies via Git. It can be used directly, but it is also designed to be used by external tools.

**See the [guide](https://psc-package.readthedocs.io/en/latest/) to learn how to use Psc-Package.**

## Installation

- Download the binary for your platform from [the releases page](https://github.com/purescript/psc-package/releases), and copy it somewhere on your PATH, or

- Build from source, using `stack install`.

If you're a **Windows Chocolatey** user, then you can install `psc-package` from the [official repo](https://chocolatey.org/packages/psc-package):

```

$ choco install psc-package

```

## Usage

```shell

# install or update the dependencies listed in psc-package.json

$ psc-package install

# install or update the package and add it to psc-package.json if not listed

$ psc-package install 

# list available commands

$ psc-package --help

```

## Design Goals

- `psc-package` should enable simple package management without the need to run Node (compare with Bower).

- `psc-package` should enable reproducible builds, at least as far as reproducing PureScript dependencies.

- `psc-package` should have a good out-of-the-box user experience (compare with Stack in Haskell), while still supporting custom package sets for advanced use cases.

- `psc-package` should only depend on tools which are available on all systems (for example, the Git client)