# bbedit-recovery

> NPM package that helps get settings from BBEdit

Latest version **0.0.2** (published 2021-07-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install bbedit-recovery
pnpm add bbedit-recovery
yarn add bbedit-recovery
bun add bbedit-recovery
```

Provides the commands `bbrec`, `bbedit-recover`, `bbedit-recovery`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-07-25 |
| First published | 2021-07-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0 |
| Dependencies | 6 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | codingChewie |
| Maintainers | codingchewie |
| Keywords | BBEdit, recovery, cli, Scripts, Stationary |

## Links

- npm: https://www.npmjs.com/package/bbedit-recovery
- Repository: https://github.com/codingChewie/bbedit-recovery
- Homepage: https://github.com/codingChewie/bbedit-recovery#readme
- Issues: https://github.com/codingChewie/bbedit-recovery/issues
- npm.io page: https://npm.io/package/bbedit-recovery

## Dependencies (6)

- [tmp](https://npm.io/package/tmp.md) ^0.2.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [commander](https://npm.io/package/commander.md) ^8.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.0.2 (latest) — 2021-07-25
- 0.0.1 — 2021-07-25

## README

# BBEdit Recovery

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/codingChewie/bbedit-recovery) ![Code Climate issues](https://img.shields.io/codeclimate/issues/codingChewie/bbedit-recovery) ![Github code size](https://img.shields.io/github/languages/code-size/codingChewie/bbedit-recovery) ![GitHub issues](https://img.shields.io/github/issues/codingChewie/bbedit-recovery) ![GitHub last commit](https://img.shields.io/github/last-commit/codingChewie/bbedit-recovery) ![GitHub License](https://img.shields.io/github/license/codingChewie/bbedit-recovery) [![GitHub forks](https://img.shields.io/github/forks/codingChewie/bbedit-recovery)](https://github.com/codingChewie/bbedit-recovery/network) [![GitHub stars](https://img.shields.io/github/stars/codingChewie/bbedit-recovery)](https://github.com/codingChewie/bbedit-recovery/stargazers)

So over the last few years as a developer I've experienced three instances of [MacBook swollen battery](https://www.consumerreports.org/laptop-computers/some-macbook-pro-batteries-can-swell-what-you-need-to-know/) syndrome. I do not know if I'm just scripting too much, too many projects with `npx` calls for React :zany_face: , or just bad luck. Either way I've found over time I was manually copying over my BBEdit settings to my NAS so I could easily setup my replacement/loaner and in the process thought there has got to be a better way then manual and could this help anyone else :thinking: .

To resolve this headache and since I've enjoyed writing more in Node I thought it be fun to write a Node CLI. Currently this is very basic but in my free time (if ever :roll_eyes: ) I'm thinking of building in `launchd` support that pushes to a repository and/or NAS.

## Installation

NPM:

```bash
npm i bbedit-recovery
```

install dependencies

```bash
cd bbedit-recovery && npm i
```

NPM link

After dependencies are added run:

```bash
npm link
```

If you're done run to remove

```bash
npm unlink
```

## How to use

This package can take three CLI commands:

```bash
bbedit-recovery
bbedit-recover
```

or the shorthand:

```bash
bbrec
```

by default with no options passed this will create a directory named `bbedit-recovery` and copy over all directories that are not empty and files. This location can be echoed with the `pwd` command in the terminal if you're unsure where files will go.

## Options

What's a CLI without options, right? Currently this takes two `dest` and `name` but I can assure you there will be more in the future.

### Destination

You can specify where the files will be copied to by passing either the commands `--name` or the shorthand `-n`. This expects and tests for a directory. If a directory isn't valid it will error out.

Example:

```bash
bbedit-recover -dest /Users/$USER/supercalifragilisticexpialidocious
```

shorthand:

```bash
bbrec -d /Users/$USER/supercalifragilisticexpialidocious
```

#### Desktop and Documents

If you'd like to copy files to your **Desktop** directory:

```bash
bbedit-recover -d Desktop
```

If you'd like to copy files to your **Documents** directory:

```bash
bbedit-recover -dest Documents
```

ewww.. a shorthand for Documents:

```bash
bbedit-recover -d Docs
```

### Name

Well, I'm hurt that you do not like the name `bbedit-recovery`. Fine, so be it, there is an option to change it just for you:

```bash
bbedit-recover -dest /Users/$USER/Desktop/supercalifragilisticexpialidocious -name recovery
```

shorthand:

```bash
bbrec -d /Users/$USER/Desktop/supercalifragilisticexpialidocious -n recover
```

### Intro

What's a CLI without a groovy terminal banner:

```bash
bbedit-recovery intro
```

### Help

Documentation writing is soooo boring. If I add a feature and forget to update the [README.md](https://github.com/codingChewie/bbedit-recovery/edit/main/README.md) you can get a listing of the commands:

```bash
bbedit-recovery --help
```

## Future Plans

- [ ] Add exclusion parameters
- [ ] Run off a `launchd`
- [ ] Ability to push to a repo

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