Skip to content
🦝 πŸ“¦ a package registry for anything, but mostly javascript 🦝 🦝 🦝
Branch: master
Clone or download
toddself and chrisdickinson Add RFC for manifest toml format (#189)
* Add RFC for Package.toml format

There are a few things that we likely can add to this, but this covers
the format as it is along with an "entrypoint" specification which we
need currently!

* [fix](docs) update based on feedback

* moar feedback

* possession is 9/10ths of the possessive

* add repo

* fix typo

* Note that optional fields may spark warnings;license is UNLICENSED by default

* Update based on feedback

* add aliasing
* add patching
* add monorepo
* add contributors
* remove Package.toml name and replace with `[TK]`

* darned typos

* Updates from feedback

* `entry` -> `main`
* clarify `type`
* rename file

* Update based on feedback

* remove legacy reg references
* add legacy shorthand reference
* fix typos
Latest commit 266dfa2 Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci feat(ci): pack cli during ci (#233) Jun 11, 2019
.github Add basic issue and PR templates (#131) Jun 10, 2019
cli fix: cannot default {log = log} Jun 14, 2019
data A little bit of docs work. May 18, 2019
docs Add RFC for manifest toml format (#189) Jun 14, 2019
misc Add engines field for ds (#236) Jun 10, 2019
services fix(storage): createdb defaults PGHOST to localhost Jun 13, 2019
tools/vcpm-sync Remove unused pipeline import from vcpm-sync. (#222) Jun 10, 2019
.all-contributorsrc docs: add enykeev as a contributor (#248) Jun 11, 2019
.dockerignore Add registry Docker build (#130) Jun 5, 2019
.editorconfig Add basic issue and PR templates (#131) Jun 10, 2019
.eslintrc Split the registry into registry, web, and storage services (#135) Jun 9, 2019
.gitignore Add optional hooks (#187) Jun 10, 2019
.markdownlint.json fix: MD005/list-indent Jun 5, 2019
.prettierrc WIP: Invitations & joining. (#72) May 19, 2019
LICENSE Sketch out a basic layout for our services. (#3) Apr 27, 2019
README.md docs: add enykeev as a contributor (#248) Jun 11, 2019
docker-compose.yml Chris/fix docker compose and url (#247) Jun 11, 2019
package-lock.json Cleanup, tidying, and other boring things. (#242) Jun 11, 2019
package.json

README.md

Entropic: a federated package registry for anything

All Contributors Code of Conduct

A new package registry with a new CLI, designed to be easy to stand up inside your network. Entropic features an entirely new file-centric API and a content-addressable storage system that attempts to minimize the amount of data you must retrieve over a network. This file-centric approach also applies to the publication API. See the API section of the manifesto for more details about the API offered.

Entropic assumes many registries co-existing and interoperating as a part of your normal workflow. All Entropic packages are namespaced, and a full Entropic package spec also includes the hostname of its registry.

The legacy node package manager is treated as a read-only archive. You may install legacy packages through your Entropic home instance.

See docs/README.md for the manifesto.

Are you interested in contributing? Do you have some feedback to share? Come talk with us in our Discourse.

What's working

Entropic is self-hosting. That means login, publication, and installation (mostly) are working. There are bugs, many unimplemented features, and the whole thing will probably fall over in a stiff breeze. We feel this is exceeding expectations for a project that's just over a month old.

Our development instance is running at https://registry.entropic.dev/. You'll probably all knock it over trying it out, I just know it.

Overview

Package specifications are fully qualified with the namespace, hostname, and package name. They look like this: namespace@example.com/pkg-name. For example, the ds cli is specified by chris@entropic.dev/ds.

If you publish a package to your local registry that depends on packages from other registries, your local instance will proactively mirror all the packages yours depends on. The goal is to keep each instance entirely self-sufficient, so installs don't have to depend on a resource that might vanish. This is also true of packages installed from the legacy node package manager: they're given the namespace legacy and mirrored.

Abandoned packages are moved to the abandonware namespace.

Every Entropic user has a namespace that matches their user name. They may additionally belong to other namespaces. Packages can be updated by any user in the package's namespace. Packages can also have a list of maintainers.

For example, user chris owns the package chris@entropic.dev/ds. Chris can invite ceejbot to maintain ds. If ceejbot accepts, they'll be able to publish new versions of ds. Meanwhile, the package lodash-people@entropic.dev/lodash can be maintained by anybody who's a member of the lodash-people namespace. This might include the user jdalton and anybody else jdalton invites. (We hear that jdd gets a dollar every time somebody uses lodash as an example.)

All packages published to Entropic are public. Our expectation is that you'll use something like the GitHub Package Registry if you need to control access to packages you publish. Or you might choose to run an Entropic instance and control access to it another way.

The only thing about Entropic that assumes you're managing javascript packages is the installer. We are open to adding other kinds of installers for other languages.

The ds cli

See INSTALLING to install.

Log in to a registry: ds login. You will be prompted to authenticate using Github.

The ds cli is configured with an .entropicrc file in your home directory. This is a TOML file. Use it to specify your preferred registry, as well as any other registries you use normally.

registry = "http://example.com"

[registries."https://entropic.dev"]
token = "a-valid-entropic-token"

[registries."http://example.com"]
token = "another-valid-entropic-token"

The cli doesn't have a very sensible shell for running commands yet, and it doesn't yet have working help. (Help for help welcomed!) You can see what commands are implemented by browsing the command source folder. See the cli readme for more notes.

At present, if you want to install packages using ds, you can run ds build in a directory with a Package.toml. This will produce a ds/node_modules directory, which you can move into place by hand. This is a temporary situation!

Packages

Packages are described by TOML files giving metadata and listing dependencies.

Here's an example Package.toml:

name = "chris@entropic.dev/ds"
version = "0.0.0-beta"

[dependencies]
"@iarna/toml" = "^2.2.3"
"legacy@entropic.dev/figgy-pudding" = "^3.5.1"
[...]

Publish a new package-version with ds publish.

Contributing

Entropic is, at the moment of this writing, the work of two people: Chris Dickinson and C J Silverio. They are not sponsored by anybody nor do they represent anyone but themselves. Chris and Ceej are seeking additional contributors but wish to onboard newcomers slowly. The project is new enough that clear direction does not always exist in the code, so contributors will need to work closely with us. Read CONTRIBUTING guide

For more, see Contributing and our Code of Conduct.

Contributors

Nick Schonning
Nick Schonning

πŸ“–
Sergey
Sergey

πŸ’»
James
James

πŸ“– πŸ’»
Zac Anger
Zac Anger

πŸ’»
Todd Kennedy
Todd Kennedy

πŸ’»
SΓ©bastien Cevey
SΓ©bastien Cevey

πŸ’»
Nikhil Ranjan
Nikhil Ranjan

πŸ’»
Nick Olinger
Nick Olinger

πŸ’»
Jonathan Weiss
Jonathan Weiss

πŸ’»
Andrew Nesbitt
Andrew Nesbitt

πŸ“–
Brenna Flood
Brenna Flood

πŸ“–
Aaron Ross
Aaron Ross

πŸ“– πŸ’»
C J Silverio
C J Silverio

πŸ’» πŸ“–
Chris Dickinson
Chris Dickinson

πŸ’» πŸ“–
Aria Stewart
Aria Stewart

πŸ’»
Pranshu Chittora
Pranshu Chittora

πŸ“–
Kate Beard
Kate Beard

πŸ“–
Zeke Sikelianos
Zeke Sikelianos

πŸ’»
Sam Saccone
Sam Saccone

πŸ“–
Mohamed Badawi
Mohamed Badawi

πŸ’»
Wes Mason
Wes Mason

πŸ’»
Alfredo Miranda
Alfredo Miranda

πŸ’»
Kirill Enykeev
Kirill Enykeev

πŸ’»

LICENSE

This project is released under the Apache 2.0 license.

You can’t perform that action at this time.