Jinx is a CLI tool for populating fresh repositories with the typical files every project creates, such as a README, licenses, and language-specific settings files.
This currently has very minimal support for project environments, namely supporting the types of projects I build myself regularly. I do intend on adding more template support and deeper argument handling in the future.
Supports Rust, TypeScript (Node), and Python project structures.
Generates: a README.md template, a generic .gitignore, a blank CHANGELOG.md, a .markdownlintignore, and one or more LICENSE files.
For Rust projects, additionally generates a deny.toml (for cargo deny) and a rustfmt.toml file
(reorder & squish imports).
Simply run jinx in the directory you wish to populate with project files.
Currently does not support supplying a path as an argument.
Linux
- Download the latest release.
- Extract the files with
tar --xz -xf jinx.tar.xz --directory <wherever you want>. - On most distributions, extract it into
/usr/binwhich is already part of your PATH. - Grant executable permissions to the binary with
sudo chmod +x jinx. - (alternatively) You can add the binary to a different directory. Just add that location to your
PATH so you can run it from anywhere (eg.
export PATH="$PATH/bin:$PATH").
You're all set! Run jinx in a new directory or jinx --help to see the help file.
Windows
- Download the latest release.
- Extract the files with 7zip to wherever you want.
- Add the directory location to your PATH like so:
- In your search bar, type
environment variables. - Select
Edit the system environment variables. - Click
Environment Variablesnear the bottom. - Double-click
Pathin theUser variables for xbox. - Click
New. - Type in the directory you extracted
jinxand.jinx-templatesto. - Click
Ok.
- In your search bar, type
You're all set! Run jinx in a new directory or jinx --help to see the help file.
Jinx source code is dual-licensed under either
at your option.