Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lawrence-laz/init
A command line tool for initializing files and directories
https://github.com/lawrence-laz/init
cli command-line command-line-tool zig
Last synced: 2 months ago
JSON representation
A command line tool for initializing files and directories
- Host: GitHub
- URL: https://github.com/lawrence-laz/init
- Owner: lawrence-laz
- License: gpl-3.0
- Created: 2024-06-26T19:46:29.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T12:35:02.000Z (6 months ago)
- Last Synced: 2024-07-28T13:57:54.642Z (6 months ago)
- Topics: cli, command-line, command-line-tool, zig
- Language: Zig
- Homepage:
- Size: 42 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```html
.__ .__ __
|__| ____ |__|/ |_
| |/ \| \ __\
| | | \ || |
|__|___| /__||__|
\/
```
Create custom project templates with ease.
## 📦 Install
1. Build from source:
```sh
git clone --depth 1 https://github.com/lawrence-laz/init && cd init && zig build --release=safe
```
2. Add an alias to your shell config:
```sh
alias init="/path/to/init/zig-out/bin/init -c '/path/to/init/config/'"
```
## 🔨 Create a template
1. Create a directory for your new template:
```sh
mkdir -p config/templates/your-template-name
```
2. Create template sub-directory structure and files, for example:
```
config/templates/your-template-name
|- src/
| |- main.zig
|- build.zig
|- build.zig.zon
```
## 🎉 Use
```sh
mkdir my-project && cd my-project
init your-template-name
```
## Parameters
Templates can have parameters, which are surrounded by three underscores (ex. `___name___`) in file contents, file and directory names.
Then they can be used by calling `init` with `-p name=value`
For example running:
```sh
init your-template-name -p name=my-project -p "description=My very own project."
```
Would replace:
- from `./your-template-name/dir-___name___/` to `./dir-my-project/`
- from `./your-template-name/___name___.txt` to `./my-project.txt`
- and contents of `some-file.txt` from `This project name is ___name___` to `This project name is my-project`