{"id":17257068,"url":"https://github.com/waterlink/plugged","last_synced_at":"2025-03-26T08:40:22.506Z","repository":{"id":66281759,"uuid":"44343100","full_name":"waterlink/plugged","owner":"waterlink","description":"Library for writing extendable CLI applications for Golang.","archived":false,"fork":false,"pushed_at":"2015-10-16T01:34:06.000Z","size":144,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-31T10:12:49.157Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/waterlink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-15T20:18:32.000Z","updated_at":"2018-06-18T14:30:18.000Z","dependencies_parsed_at":"2023-03-13T20:30:10.397Z","dependency_job_id":null,"html_url":"https://github.com/waterlink/plugged","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waterlink%2Fplugged","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waterlink%2Fplugged/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waterlink%2Fplugged/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waterlink%2Fplugged/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/waterlink","download_url":"https://codeload.github.com/waterlink/plugged/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245622800,"owners_count":20645676,"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","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":[],"created_at":"2024-10-15T07:16:17.023Z","updated_at":"2025-03-26T08:40:22.473Z","avatar_url":"https://github.com/waterlink.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# plugged\n\nLibrary for writing extendable CLI applications.\n\n## Usage\n\n```go\nimport \"github.com/waterlink/plugged\"\n```\n\n### \"Gateway\" application\n\n```go\nfunc main() {\n        plugged.Gateway(\"appname\", \"My super cli application.\", os.Args)\n}\n```\n\nExample usage:\n\n```bash\n$ ./appname\nUSAGE: appname command [options]\n\nappname - My super cli application.\n\nAvailable commands:\n\n- find     - Find some stuff.\n- activate - Activate stuff.\n- help     - This help info.\n\nTo get help for any of commands you can do `appname help command` or `appname\ncommand --help`.\n$ ./appname find --help\n# .. here output of `appname-find --help` ..\n```\n\n### Plugin application\n\n```go\nfunc main() {\n        plugged.Plugin(\"appname\", \"find\", \"Find some stuff.\", os.Args, handler)\n}\n\nfunc handler(args []string) {\n        // .. Find some stuff here ..\n}\n```\n\n## Installing plugin\n\nMake sure you have installed plugin on your `PATH` and just run:\n\n```bash\nappname --plugged-install find\n```\n\n## Plugin interface\n\nPlugin does not necessary need to be written in `go` and/or using `plugged`\nlibrary. Instead it is required for a plugin to abide to the following\ninterface:\n\n```bash\nappname-find --plugged-description  # =\u003e Find some stuff.\nappname-find --help                 # =\u003e .. help message ..\n```\n\n## Development\n\nYou will need to have working recent `golang` installation (`1.5+` at a time of\nwriting). And the repo needs to be cloned into your `GOPATH`.\n\n- `go test` runs tests.\n- Please follow TDD.\n\n## Contributing\n\n1. Fork it ( https://github.com/waterlink/plugged/fork )\n2. Create your feature branch (git checkout -b my-new-feature)\n3. Commit your changes (git commit -am 'Add some feature')\n4. Push to the branch (git push origin my-new-feature)\n5. Create a new Pull Request\n\n## Contributors\n\n1. [waterlink](https://github.com/waterlink) - Oleksii Fedorov, creator,\n   maintainer.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaterlink%2Fplugged","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaterlink%2Fplugged","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaterlink%2Fplugged/lists"}