https://github.com/reddec/mkproj
https://github.com/reddec/mkproj
bash-script template-project
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/reddec/mkproj
- Owner: reddec
- License: mit
- Created: 2017-02-17T10:09:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-27T07:17:02.000Z (over 9 years ago)
- Last Synced: 2025-03-09T00:06:39.143Z (over 1 year ago)
- Topics: bash-script, template-project
- Language: Shell
- Homepage: https://reddec.gitbooks.io/mkproj/content/
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Operate templates for projects
Please see documentation https://reddec.gitbooks.io/mkproj/content/
## Usage
```
Operate directory templates
commands:
ls List available templates
content Print content of template
rm [template_name...] Remove template
export Export content of template to current dir
init Initialize directory and apply templates
save [template_name] Save current directory as template
backup Compress all templates to tar.gz
restore Unpack all templates from tar.gz
pull Pull templates from remote repo
push Push templates to remote repo
help Show help
install Install script to /usr/bin/mkproj
```
## How to create template
1. Create a directory `mkdir template_name`
2. Put some files
3. Save template by `mkproj save`
## Special files
`post-init` - executable script (+x) that runs after apply template
`TARGET_FILE.template` - template that will processed by `envsubst`
`TARGET_FILE.cgi` - script, that output will save instead of it (aka CGI in web)
## How to use template
1. Run `mkproj ls` and remember template name
2. Run `mkproj init TEMPLATE_NAME` and be happy