# @coboxcoop/config

> rc configuration file for cobox

Latest version **1.0.2-alpha.1** (published 2022-04-07) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @coboxcoop/config
pnpm add @coboxcoop/config
yarn add @coboxcoop/config
bun add @coboxcoop/config
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2-alpha.1 |
| Published | 2022-04-07 |
| First published | 2020-07-29 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 37.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | magma-collective |
| Maintainers | kyphae, ameba23 |
| Keywords | config, cobox, yaml, rc |

## Links

- npm: https://www.npmjs.com/package/@coboxcoop/config
- Repository: https://gitlab.com/coboxcoop/config
- Homepage: https://cobox.cloud
- Issues: https://gitlab.com/coboxcoop/config/issues
- npm.io page: https://npm.io/package/@coboxcoop/config

## Dependencies (3)

- [find-up](https://npm.io/package/find-up.md) ^4.1.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.14.0
- [@coboxcoop/logger](https://npm.io/package/@coboxcoop/logger.md) 1.0.1-alpha.1

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.0.2-alpha.1 (latest) — 2022-04-07
- 1.0.1-alpha.1 — 2020-07-29
- 1.0.0-alpha.1 — 2020-07-29

## README

# config

<div align="center">
  <img src="https://cobox.cloud/src/svg/logo.svg">
</div>

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

## Table of Contents

  - [About](#about)
  - [Install](#install)
  - [Usage](#usage)
  - [API](#api)
  - [Contributing](#contributing)
  - [License](#license)

## About
**CoBox** is an encrypted p2p file system and distributed back-up tool. [README](https://gitlab.com/coboxcoop/readme) provides a map of the project.

`config` generates a `.coboxrc` file which is stored in your home directory. It stores app configuration such as your nickname, storage directory and mount directory.

## Install

```
npm i -g @coboxcoop/config

```

## Usage

See `/tests`

## API
See swagger documentation... (we won't have this for a while).

## Contributing

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

# License

[`AGPL-3.0-or-later`](./LICENSE)

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