{"id":20063452,"url":"https://github.com/vanilla-os/vib-plugin","last_synced_at":"2025-09-12T07:35:29.225Z","repository":{"id":212366716,"uuid":"727148212","full_name":"Vanilla-OS/vib-plugin","owner":"Vanilla-OS","description":"A template repository to make the creation of vib plugins easier","archived":false,"fork":false,"pushed_at":"2025-08-20T08:37:35.000Z","size":18,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-20T10:31:16.770Z","etag":null,"topics":["vanilla-os","vib","vib-plugin"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Vanilla-OS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"vanilla-os","liberapay":"fabricators"}},"created_at":"2023-12-04T09:31:37.000Z","updated_at":"2025-08-20T08:37:38.000Z","dependencies_parsed_at":"2023-12-13T22:24:02.219Z","dependency_job_id":"081efad2-de14-42ed-837d-681d16f3578b","html_url":"https://github.com/Vanilla-OS/vib-plugin","commit_stats":null,"previous_names":["vanilla-os/vib-plugin"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/Vanilla-OS/vib-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fvib-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fvib-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fvib-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fvib-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vanilla-OS","download_url":"https://codeload.github.com/Vanilla-OS/vib-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanilla-OS%2Fvib-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274777010,"owners_count":25347642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vanilla-os","vib","vib-plugin"],"created_at":"2024-11-13T13:42:17.298Z","updated_at":"2025-09-12T07:35:29.184Z","avatar_url":"https://github.com/Vanilla-OS.png","language":"Go","funding_links":["https://github.com/sponsors/vanilla-os","https://liberapay.com/fabricators"],"categories":[],"sub_categories":[],"readme":"\n# vib-plugin\n\nA template to create plugins for [vib](https://github.com/vanilla-os/vib)\n\n## Usage\n\nTo use this template, fork it and change the module name in `go.mod`.\n\nThen you can modify the source in `src/plugin.go` to create your plugin.\n\nA couple of test cases should also be added in `src/plugin_test.go`, view [vib-fsguard](https://github.com/vanilla-os/vib) and [vib-pacman](https://github.com/axtloss/vib-plugins/blob/main/pacman/plugin_test.go) for examples.\n\nWe recommend adding the `vib-plugin` tag to your repo so other people can discover it.\n\n## Plugin requirements\n\n`src/plugin.go` explains all requirements for plugins with code examples.\n\nA short tldr:\n\n- vib requires `BuildModule(moduleInterface *C.char, recipeInterface *C.char) *C.char` to be available as it is used as the entry point for the plugin. Any other functions can be freely declared and will not be used by vib\n- plugins need to pass their name and plugin type through the `PlugInfo() *C.Char` function, the api contains a struct of `api.PluginInfo` which makes this easier, vib expects this function to return a json marshalled version of this struct\n- Each plugin needs to have a custom struct for the module, with at least two mandatory values: `Name string` and `Type string`\n- It is recommended, but not required, to use the api functions for source definition or downloading sources\n\n## Building\nPlugins can be built with `go build -buildmode=c-shared -o plugin.so`, producing a `.so` file.\nTo use the plugin, the `.so` file has to be moved into the `plugins/` directory of the vib recipe.\nPlugins are only loaded when required, if a recipe never uses a plugin example, `example.so` will never be loaded.\n\nThis template contains a GitHub workflow that can build the plugin with the right arguments automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanilla-os%2Fvib-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanilla-os%2Fvib-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanilla-os%2Fvib-plugin/lists"}