Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d7omdev/config-files-manager
A Package to manage local config files from the command line.
https://github.com/d7omdev/config-files-manager
config config-manager configuration-files
Last synced: about 1 month ago
JSON representation
A Package to manage local config files from the command line.
- Host: GitHub
- URL: https://github.com/d7omdev/config-files-manager
- Owner: d7omdev
- License: mit
- Created: 2024-05-14T08:01:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-15T22:48:45.000Z (8 months ago)
- Last Synced: 2024-11-11T12:52:46.540Z (about 2 months ago)
- Topics: config, config-manager, configuration-files
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/config-files-manager
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Config Files Manager
A Pakage to manage local config files from the command line.
## Why ?
Tired of wrestling with scattered configuration files? i know i have been.
Config Files Manager is here to save the day!
- Centralized Control: Manage all your configuration files effortlessly from the command line.
- Simplified Management: Add, remove, update, and backup files with ease, no more manual headaches.
- Peace of Mind: Never worry about lost settings again – Config Files Manager has your back.
In short, Config Files Manager is the ultimate tool for simplifying your configuration file woes.
## Features
- **Add a new Config file**: Add a new configuration file to the pakage.
- **List all config files**: Lists all the configuration files that are currently being managed by the pakage to choose from and open in the text editor.
- **Remove a config file**: Remove a configuration file from the pakage.
- **Update a config file**: Update a configuration file name or path.
- **Set the editor**: Set the text editor that will be used to open configuration files.
- **Show path of the config file**: This feature shows the path of the current configuration file.
-
Backup options
Provides options for backing up your configuration files.
- Create a backup of all config files: Create a backup of all configuration files managed by the package.
- List all backup files: List all the backup files that are currently being managed by the package.
- Use a backup file: Use a backup file to restore the configuration files.
- Delete a backup file: Delete a backup file.
## Requirements
- Node.js version 12 or higher
- NPM (Node Package Manager)
## Installation
run the following command to install the package globally
```sh
npm i -g config-files-manager
```
or for pnpm
```sh
pnpm i -g config-files-manager
```
## Usage
To use the Config Files Manager, simply run the following command in the terminal:
```sh
config-files-manager
```
or
```sh
cfm
```
You can also specify the command you want to run directly from the terminal:
- `--add` or `-a`: Add a new configuration file.
- `--list` or `-l`: List all configuration files.
- `--remove` or `-r`: Remove a configuration file.
- `--update` or `-u`: Update a configuration file.
- `--backup` or `-b`: Backup options.
- `--set-editor` or `-s`: Set the text editor.
- `--help` or `-h`: Show help.
## License
this project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details
## Contributing
For contributions, please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file