# @bbcommons/bbkit

> A command-line tool for working with broadband data

Latest version **0.1.0-alpha.1** (published 2023-10-10) · GPL-3.0-only license · 0 weekly downloads

## Install

```sh
npm install @bbcommons/bbkit
pnpm add @bbcommons/bbkit
yarn add @bbcommons/bbkit
bun add @bbcommons/bbkit
```

Provides the command `bb`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha.1 |
| Published | 2023-10-10 |
| First published | 2023-10-10 |
| Weekly downloads | 0 |
| License | GPL-3.0-only |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 5 |
| Unpacked size | 19.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Broadband Commons |
| Maintainers | rbrtmrtn |
| Keywords | broadband, broadband-mapping, digital-divide, fcc |

## Links

- npm: https://www.npmjs.com/package/@bbcommons/bbkit
- Repository: https://github.com/broadband-commons/bbkit
- Homepage: https://github.com/broadband-commons/bbkit#readme
- Issues: https://github.com/broadband-commons/bbkit/issues
- npm.io page: https://npm.io/package/@bbcommons/bbkit

## Dependencies (5)

- [async](https://npm.io/package/async.md) ^3.2.4
- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [figlet](https://npm.io/package/figlet.md) ^1.6.0
- [commander](https://npm.io/package/commander.md) ^10.0.1
- [yauzl-promise](https://npm.io/package/yauzl-promise.md) ^4.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.0-alpha.1 (latest) — 2023-10-10

## README

# bbkit

> 🚨 this is a work in progress!

A command-line tool for working with broadband datasets (currently just FCC availability)

## Installation

TODO not yet packaged; see Development section for how to install in development
mode

## Usage

### BDC Availability

`bb bdc-availability download`

```bash
Usage: index [options] <entity-type> <entity-ids> <filing-type> <output-dir>

Arguments:
  entity-type                      Only `states` is supported currently
  entity-ids                       `all`, or a comma-separated list of entity IDs, e.g. `ca,nv,az`
  filing-type                      `fixed` or `mobile`
  output-dir                       Path to the directory to save downloads to

Options:
  -t, --tech <tech>                Technology names or codes to filter by, e.g. `fiber`, `3g`, `wired`, or
                                   `10,40,50`
  -f, --format <format>            File format (for mobile only; `gpkg` or `shp`)
  -d, --filing-date <filing-date>
  -h, --help
```

#### Examples

- Download fixed availability for all states for the latest filing period: `bb bdc-availability download states all fixed`
- Download fixed availability for a previous filing date: `bb bdc-availability download states all fixed -d 2022-12-31`
- Download all technologies for a single state: `bb bdc-availability download states oh fixed`
- Download fiber availability for a single state: `bb bdc-availability download states oh fixed -t fiber`
- Download all technologies for a few states: `bb bdc-availability download states co,wy,mt fixed`

## Development

1. Clone this repo to your local machine
2. `cd` into the repo
3. Run `npm i -g .`

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