{"id":48652546,"url":"https://github.com/pders01/koha-plugin","last_synced_at":"2026-04-10T08:52:36.764Z","repository":{"id":346540306,"uuid":"808265674","full_name":"pders01/koha-plugin","owner":"pders01","description":"Build koha plugins, but faster.","archived":false,"fork":false,"pushed_at":"2026-03-24T09:34:15.000Z","size":244,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-10T08:52:33.919Z","etag":null,"topics":["koha-plugin"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pders01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-30T17:58:27.000Z","updated_at":"2026-03-25T09:08:03.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pders01/koha-plugin","commit_stats":null,"previous_names":["pders01/koha-plugin"],"tags_count":0,"template":true,"template_full_name":"bywatersolutions/dev-koha-plugin-kitchen-sink","purl":"pkg:github/pders01/koha-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pders01%2Fkoha-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pders01%2Fkoha-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pders01%2Fkoha-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pders01%2Fkoha-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pders01","download_url":"https://codeload.github.com/pders01/koha-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pders01%2Fkoha-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31635969,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["koha-plugin"],"created_at":"2026-04-10T08:52:36.054Z","updated_at":"2026-04-10T08:52:36.746Z","avatar_url":"https://github.com/pders01.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koha-plugin\n\nA scaffolding tool for Koha plugins. Generates correct, working plugin code with interactive hook selection, API route composition, and version management.\n\n[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)\n\n## What it does\n\n- **`init`** — Interactive plugin initialization: prompts for metadata, lets you pick from 50+ Koha hooks, generates the plugin module with working stubs, config file, manifest, templates, and `.gitignore`\n- **`add`** — Incrementally add components: UI page templates, API routes (with controller generation), Node.js frontend projects\n- **`increment`** — Semver-aware version bumping across config, module, and package.json\n- **`package`** — Create `.kpz` files for Koha plugin installation\n- **`ktd`** — One-command deployment to KTD containers\n\nThe generated plugin code is standard Koha — no runtime dependency on this tool. You can stop using the scaffolder at any time and continue developing by hand.\n\n## Quick start\n\n```bash\ngit clone https://github.com/pders01/koha-plugin.git my-plugin\ncd my-plugin \u0026\u0026 rm -rf .git \u0026\u0026 git init\ncarton install    # or: cpanm --installdeps .\nperl bin/koha-plugin.pl init\n```\n\nSee the [quickstart guide](docs/quickstart.md) for the full walkthrough.\n\n## Installation\n\n### Dependencies\n\nInstall via [Carton](https://metacpan.org/pod/Carton) (recommended) or any CPAN client:\n\n```bash\ncarton install\n# or: cpanm --installdeps .\n```\n\nThe tool also works with globally installed modules or `local::lib`. Carton is not required.\n\n### Task runner (optional)\n\n[just](https://just.systems/) provides convenient shortcuts. Run `just` for available commands. Everything `just` does can also be done directly with `perl bin/koha-plugin.pl`.\n\n### Standalone binary\n\nBuild a self-contained binary that needs no Perl setup on the target system:\n\n```bash\njust binary\n# Binary at dist/koha-plugin\n```\n\n## Documentation\n\n- [Quickstart](docs/quickstart.md) — zero to working plugin in 5 minutes\n- [Command reference](docs/commands.md) — all commands and options\n- [Hook reference](docs/koha-plugin-hooks.md) — every Koha plugin hook with descriptions, return types, and groupings\n- [Vue Islands guide](docs/vue-islands.md) — Vue micro frontends in Koha plugins\n- [Writing a simple plugin](docs/how-to-write-a-simple-plugin.md) — minimal example\n- [POD style guide](docs/pod-style-guide.md) — conventions for hook stubs\n- [Live Circ Feed example](examples/circ-feed/) — full-featured demo plugin with API, Vue island, and polling\n\n## Configuration\n\nThe tool reads plugin metadata from `koha-plugin.yml` (or `koha-plugin.json`):\n\n```yaml\nname: \"Koha::Plugin::Com::Example::MyPlugin\"\nauthor: \"Your Name\"\nversion: \"0.1.0\"\ndescription: \"What your plugin does\"\nminimum_version: \"22.11.00.000\"\nmaximum_version: \"\"\nrelease_filename: \"example-myplugin\"\nstatic_dir_name: \"static\"\ndate_authored: \"2026-03-20\"\ndate_updated: \"2026-03-20\"\n```\n\nLegacy `.env` files are still supported. Migrate with `koha-plugin migrate yml`.\n\n## Examples\n\n- [koha-plugin-pomodoro](https://github.com/pders01/koha-plugin-pomodoro)\n- [koha-plugin-command-palette](https://github.com/pders01/koha-plugin-command-palette)\n\n## Related\n\n- [LMSCloud plugin utils](https://github.com/LMSCloudPaulD/koha-plugin-lmscloud-util) — shared utilities for database migrations, OPAC pages, and i18n\n- [Kitchen Sink plugin](https://github.com/bywatersolutions/dev-koha-plugin-kitchen-sink) — reference implementation of every Koha plugin hook\n\n## Contributing\n\nContributions welcome. Please use `perltidy` and `perlimports` with the shipped configuration files.\n\n## License\n\n[GPL v3](https://github.com/pders01/koha-plugin?tab=GPL-3.0-1-ov-file#readme)\n\n## Support\n\nPing me on [Koha's Mattermost](https://chat.koha-community.org) **@paulderscheid**.\n\n## Author\n\n[@pders01](https://www.github.com/pders01)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpders01%2Fkoha-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpders01%2Fkoha-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpders01%2Fkoha-plugin/lists"}