-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# configfiles | ||
|
||
**configfiles** 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 is needed to store your configuration files. | ||
|
||
Please follow this structure: | ||
|
||
```txt | ||
/files/ | ||
/module1/ | ||
/module2/ | ||
/settings.json | ||
/configurationfile.txt | ||
/module3/ | ||
/scripts/ | ||
/scriptfile.sh | ||
``` | ||
|
||
## Usage | ||
|
||
### Initialization / configuration | ||
|
||
`configfiles init` Initialize *configfiles* on the current user session. | ||
|
||
### Deploy configuration files | ||
|
||
`configfiles deploy [moduleName...]` Deploy the configuration files for the given module name. | ||
|
||
### Run script | ||
|
||
`configfiles run <scriptName>` Execute the script identifying by the given script name. | ||
|
||
## License | ||
|
||
This project is under Apache-2.0 license. See LICENSE file. |