Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mindsers/configfile
Personal config files manager
https://github.com/mindsers/configfile
config config-management configuration configuration-files configuration-management hacktoberfest
Last synced: 3 months ago
JSON representation
Personal config files manager
- Host: GitHub
- URL: https://github.com/mindsers/configfile
- Owner: mindsers
- License: apache-2.0
- Created: 2017-09-07T21:54:32.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-04T03:16:23.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T16:04:48.650Z (9 months ago)
- Topics: config, config-management, configuration, configuration-files, configuration-management, hacktoberfest
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/configfile
- Size: 1.57 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# configfile
[](https://www.npmjs.com/package/configfile)
[](https://www.npmjs.com/package/configfile)
[](https://github.com/Mindsers/configfile/blob/master/LICENSE)
[](https://www.patreon.com/bePatron?u=9715649)
[](https://community.nathanaelcherrier.com/c/open-source/configfile/8)
*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.
- `-f, --force` force current configuration to be overwritten.
- `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 ` or `configfile s r `: 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 a 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! Go on my [Patreon page](https://www.patreon.com/mindsers) and become my joyful patron!!
[](https://www.patreon.com/bePatron?u=9715649)
For help on how to support Configfile, please refer to [The awesome people who support Configfile](https://github.com/Mindsers/configfile/blob/develop/SPONSORS.md).
## License
This project is under Apache-2.0 license. See LICENSE file.