skeleton-cli
| Crates.io | skeleton-cli |
| lib.rs | skeleton-cli |
| version | 0.1.0 |
| source | src |
| created_at | 2024-07-09 16:01:45.812822 |
| updated_at | 2024-07-09 16:01:45.812822 |
| description | A project scaffolding utility |
| homepage | https://github.com/terror/skeleton |
| repository | https://github.com/terror/skeleton |
| max_upload_size | |
| id | 1297244 |
| size | 76,009 |
liam (terror)
documentation
README
skeleton 💀
skeleton is a tool that makes it easier to start new projects.
It stores your commonly used project specific files in one place, letting you easily apply them to new projects.
In essence, a template is a file ending in .skeleton with a front-matter and
content. The front-matter is structured
YAML with effect and free
variables.
An effect variable is pre-defined to perform some action. As of now, there are only 3 pre-defined variables of this type:
| Name | Type | Required | Description |
|---|---|---|---|
command |
String | No | A command to run on a template post-write. |
filename |
String | Yes | Specifies the name of the templates destination location during application. |
groups |
Sequence | No | Groups this template belongs to, used commonly when batch applying templates. |
See subcommand.rs for further elaboration on these effect variables.
A free variable is used to substitute into the templates content, you can also specify whether or not to be interactively prompted for these types of variables when applying templates.
The binary is called sk and has only been tested on a Unix-based machine.
Demo
Installation
You can install the skeleton command-line utility via the rust package manager cargo:
cargo install skeleton-cli
...or you can build it from source:
git clone https://github.com/terror/skeleton
cd skeleton
cargo install --path .
Usage
Usage: sk <COMMAND>
Commands:
add Add a new template
apply Apply a template
edit Edit an existing template
list List all templates
remove Remove an existing template
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Prior Art
skeleton is a re-implementation and improvement of the Python program I wrote a while back called bp, which you can find here.