# bauble

> Manage components packaged in zip files

Latest version **0.2.2** (published 2017-10-17) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install bauble
pnpm add bauble
yarn add bauble
bun add bauble
```

Provides the command `bauble`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2017-10-17 |
| First published | 2017-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 11 |
| Known vulnerabilities | 0 (+49 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Michael Jaworski |
| Maintainers | mwjaworski |
| Keywords | cli, command line |

## Links

- npm: https://www.npmjs.com/package/bauble
- Repository: https://github.com/mwjaworski/bauble
- Issues: https://github.com/mwjaworski/bauble/issues
- npm.io page: https://npm.io/package/bauble

## Dependencies (11)

- [tar](https://npm.io/package/tar.md) ^4.0.1
- [axios](https://npm.io/package/axios.md) ^0.16.2
- [jszip](https://npm.io/package/jszip.md) ^3.1.4
- [lodash](https://npm.io/package/lodash.md) 4.17.4
- [vorpal](https://npm.io/package/vorpal.md) ^1.12.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^4.0.2
- [jsonfile](https://npm.io/package/jsonfile.md) 4.0.0
- [cli-color](https://npm.io/package/cli-color.md) 1.2.0
- [cli-table](https://npm.io/package/cli-table.md) 0.3.1
- [micromatch](https://npm.io/package/micromatch.md) ^3.1.0
- [semver-compare](https://npm.io/package/semver-compare.md) 1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2017-10-17
- 0.2.1 — 2017-10-16
- 0.2.0 — 2017-10-16
- 0.1.0 — 2017-10-11

## README

# Bauble

[![Build Status](https://img.shields.io/badge/bauble-available-green.svg)](https://www.npmjs.com/package/bauble)
[![Build Status](https://travis-ci.org/mwjaworski/bauble.svg?branch=docs-and-testing)](https://travis-ci.org/mwjaworski/bauble)
[![Coverage Status](https://coveralls.io/repos/github/mwjaworski/bauble/badge.svg?branch=master)](https://coveralls.io/github/mwjaworski/bauble?branch=master)
[![npm version](https://badge.fury.io/js/bauble.svg)](https://badge.fury.io/js/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:

1. Resolves the reference against configurable scoping rules (eg @internal/sub-folder/repo)
2. Pulls and caches a zip, tar, or folder from the web, git, or local folder
3. Reviews the _bower.json_, _package.json_ or _bauble.json_ rules to install further archives (ie. configurable per scope or url match)
4. 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](npmjs.org).

```bash
npm install --global bauble;
```

Install globally via [yarn](https://yarnpkg.com/).

```bash
yarn global add bauble;
```

## Usage

After Bauble is installed globally, you can run `bauble` from the command-line interface in interactive mode:

```bash
bauble
```

You can invoke any command as a one-off by giving the command on the command-line.

```bash
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](http://openopensource.org/).

## License

MIT. Copyright (c) 2017-10-11 [Michael Jaworski](https://github.com/mwjaworski).

---
_Source: https://npm.io/package/bauble · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._