# configfile

> Manage your dotfiles and setup scripts from a git repository.

Latest version **0.3.1** (published 2018-08-05) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2018-08-05 |
| First published | 2017-09-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mindsers |
| Maintainers | mindsers |
| Keywords | dotfiles, config, cli, symlink |

## Links

- npm: https://www.npmjs.com/package/configfile
- Repository: https://github.com/mindsers/configfile
- Homepage: https://docs.configfile.sh
- Issues: https://github.com/mindsers/configfile/issues
- Funding: https://github.com/sponsors/mindsers
- npm.io page: https://npm.io/package/configfile

## 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

- 0.3.1 (latest) — 2018-08-05
- 0.3.0 — 2017-11-15
- 0.2.1 — 2017-10-13
- 0.2.0 — 2017-10-12
- 0.1.1 — 2017-09-24
- 0.1.0 — 2017-09-24

## README

# configfile

[![npm](https://img.shields.io/npm/v/configfile.svg?style=flat-square)](https://www.npmjs.com/package/configfile)
[![npm](https://img.shields.io/npm/dt/configfile.svg?style=flat-square)](https://www.npmjs.com/package/configfile)
[![npm](https://img.shields.io/npm/l/configfile.svg?style=flat-square)](https://github.com/Mindsers/configfile/blob/master/LICENSE)
[![Beerpay](https://beerpay.io/Mindsers/configfile/badge.svg?style=flat-square)](https://beerpay.io/Mindsers/configfile)
[![Gitter](https://img.shields.io/gitter/room/mindsers/configfile.svg?style=flat-square)](https://gitter.im/mindsers/configfile)

*configfile* is a command line tool that help user to manage their own configuration files.

## Data storage

This tool **does not store** configuration files for you. A git repo ([dotfiles](https://github.com/topics/dotfiles)) is needed to store your configuration files.

Please follow this structure:

```txt
/files/
    /module1/
    /module2/
        /settings.json
        /configurationfile.txt
    /module3/
/scripts/
    /scriptfile.sh
```

## Installation

To install *Configfile*, you need to use NPM or Yarn.

```bash
yarn global add configfile@latest
```

## Usage

- `configfile init` or `configfile i`: Initialize *configfile* on the current user session.
- `configfile modules list` or `configfile m l`: Display a list of all modules available via *Configfile*.
- `configfile modules deploy [moduleName...]` or `configfile m d [moduleName...]`: Deploy the configuration files for the given module name.
    - `-l, --local` deploy authorized file to the current directory.
- `configfile scripts` or `configfile s`: Display a list of all scripts available via *Configfile*.
- `configfile scripts run <scriptName>` or `configfile s r <scriptName>`: Execute the script identifying by the given script name.

## Contribution

Contributions to the source code of *Configfile* are welcomed and greatly appreciated. For help on how to contribute in this project, please refer to [How to contribute to Configfile](https://github.com/Mindsers/configfile/blob/develop/CONTRIBUTING.md).

## Support

*Configfile* is licensed under an Apache-2.0 license, which means that it's completely free open source software. Unfortunately, *Configfile* doesn't make itself. Version 1.0.0 is the next step, which will result in many late, beer-filled nights of development.

If you're using *Configfile* and want to support the development, you now have the chance! Head over to Beerpay, and donate a beer or two!

[![Beerpay](https://beerpay.io/Mindsers/configfile/badge.svg)](https://beerpay.io/Mindsers/configfile)

## License

This project is under Apache-2.0 license. See LICENSE file.

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