{"id":21258855,"url":"https://github.com/spacebro/clibro","last_synced_at":"2025-03-15T06:35:06.068Z","repository":{"id":57200186,"uuid":"79356725","full_name":"spacebro/clibro","owner":"spacebro","description":"Command Line Interface for spacebro-client","archived":false,"fork":false,"pushed_at":"2020-07-15T10:47:41.000Z","size":99,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-01T00:37:08.732Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/spacebro.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}},"created_at":"2017-01-18T16:00:04.000Z","updated_at":"2018-12-11T15:16:13.000Z","dependencies_parsed_at":"2022-09-16T15:12:33.879Z","dependency_job_id":null,"html_url":"https://github.com/spacebro/clibro","commit_stats":null,"previous_names":["soixantecircuits/spacebro-client-cli"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacebro%2Fclibro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacebro%2Fclibro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacebro%2Fclibro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacebro%2Fclibro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spacebro","download_url":"https://codeload.github.com/spacebro/clibro/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243079440,"owners_count":20232990,"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-11-21T04:11:11.549Z","updated_at":"2025-03-15T06:35:06.049Z","avatar_url":"https://github.com/spacebro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# clibro\n\nCommand Line Interface for connecting to a [Spacebro](https://github.com/spacebro/spacebro) server.\n\n## 🌍 Installation\n\n```bash\n$ yarn global add clibro\n```\n\nor\n\n```bash\n$ npm global add clibro\n```\n\n## ⚙ Configuration\n\nYou can pass a custom config file as second argument like this:\n\n```bash\n$ clibro my-config.json\n```\n\nThe JSON settings looks like:\n\n```JSON\n{\n  \"service\": {\n    \"spacebro\": {\n      \"address\": \"spacebro.space\",\n      \"port\": 3344,\n      \"channel\": \"media-stream\",\n      \"client\": \"clibro\"\n    }\n  }\n}\n```\n\n## 👋 Usage\n\nOnce clibro is installed, you can run it with:\n\n```bash\n$ clibro\n```\n\nYou will then enter the clibro [Command-line interface](https://en.wikipedia.org/wiki/Command-line_interface). You can run the following commands:\n\n#### Help\n```\nclibro$ help\n```\n\nDisplays the list of commands.\n\n#### Quit\nTo quit type: `exit` then ⏎\n\n#### Emit event\nTo emit an event, use the `emit` command with the name of the event and the data you want to pass:\n\n```\nclibro$ emit myEvent '{\"msg\":\"moto\"}'\n```\n\nYou can pass additional options to the `emit` command:\n\n- `--interval X eventName`: the event is emitted every `X` seconds,\n- `--stop eventName`: stops interval emitting for the event `eventName`\n\nSo you can type: `emit --interval 5 foobar \"{'msg':'hello'}\"` to emit the event `foobar` every `5` seconds with parameters `{'msg':'hello'}`\n\nYou can then type `emit --stop foobar` to stop emitting `foobar`.\n\n#### Subscribe event\nYou can subscribe to an event. If you want `clibro` to print a message in the terminal every time it receives an event named `helloWorld`, you use the `subscribe` command:\n\n```\nclibro$ subscribe helloWorld\n```           \n\n#### Unsubscribe event\nTo remove the subscription, use the `unsubscribe` command:\n\n```\nclibro$ unsubscribe helloWorld\n```\n\n## 📦 Dependencies\n\nFor this project we use:\n\n- spacebro-client\n- vorpal\n\n## 🕳 Troubleshooting\n\nIf you need any help to use clibro, please open an issue. We will try to reply as fast we can.\n\n## ❤️ Contribute\n\nIf you love the project, contribute! If you have an idea, or something you want changed, open an issue and/or make a pull request.\n\nWhen contributing, please make sur your code follows [the standard-js format](https://standardjs.com/) and passes every unit test by running the following scripts:\n\n``` js\n$ yarn lint\n...\n$ yarn test\n```\n\nThank you!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacebro%2Fclibro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspacebro%2Fclibro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacebro%2Fclibro/lists"}