towk/makeshift
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

chore: added individual READMEs to default plugins

Browse source
This commit is contained in:
David Allen 2025-08-31 22:54:18 -06:00
parent 0c87336d58
commit fb6f6933a2
Signed by: towk
GPG key ID: 0430CDBE22619155
2 changed files with 47 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
pkg/plugins/smd/README.md Normal file
View file

@ -0,0 +1,13 @@
# Makeshift SMD Plugin
This `makeshift` plugin fetchs data from [SMD](https://github.com/OpenCHAMI/smd) and stores it in the `storage.KVStore` passed to the `Run()` function. This plugin can be used in conjunction with other plugins like the `jinja2` plugin to render files using the data stored.
Here's a simple example.
```bash
makeshift download -p /etc/hosts --plugins smd,jinja2 -xr
```
This example downloads all the files in the `/etc/hosts` directory and renders the Jinja 2 templates with the data fetched from SMD. Then, the `-x` and `-r` flags tells the CLI to extract and remove the archive respectively.
Since plugins are ran in the order specified with the CLI, be sure to always call the `smd` plugin before reading from the `storage.KVStore` like in the example above or else the fetched data will not exist!