Bauble
The do-it-yourself package manager
What does Bauble do?
Bauble is a package manager supporting self-hosted archive sets. Bauble provides the standard set of package management tools, but is designed to work alongside existing bower or npm package configurations.
Bauble supports archives distributed through the web, github repositories, or local folders. It supports archives being pulled from multiple sources and also searching across multiple sources.
Archive is used to refer to any package Bauble can install and should be taken as a synonym for module, package, or component.
How does Bauble work?
When Bauble installs archives it:
- Resolves the reference against configurable scoping rules (eg @internal/sub-folder/repo)
- Pulls and caches a zip, tar, or folder from the web, git, or local folder
- Reviews the bower.json, package.json or bauble.json rules to install further archives (ie. configurable per scope or url match)
- All archives are placed in project archive folders, defined by the scope or match rule
Bauble does not pass through any commands to existing package managers. It is a stand-alone package manager which allows a development team to distribute packages as they choose.
Why Bauble?
The primary use-case is for corporations with their own internal archive sets.
Installation
Bauble relies on Node v6 and upwards
Install globally via npm.
npm install --global bauble;
Install globally via yarn.
yarn global add bauble;
Usage
After Bauble is installed globally, you can run bauble
from the command-line interface in interactive mode:
bauble
You can invoke any command as a one-off by giving the command on the command-line.
bauble [command] <options>
Commands
Command | Purpose |
---|---|
version |
Write the current version |
cache |
Install a archive(s) to local cache |
uncache |
Remove a archive from local cache |
install |
Install a archive(s) to the project |
uninstall |
Remove a archive to the project |
resolve |
Report on archive version and access |
status |
Write a summary of the projects archive rules |
OPEN Statuc
Bauble is an OPEN Open Source Project.
License
MIT. Copyright (c) 2017-10-11 Michael Jaworski.