{"id":21260337,"url":"https://github.com/nlm/briq-cli","last_synced_at":"2025-07-11T03:31:10.996Z","repository":{"id":38108316,"uuid":"499201728","full_name":"nlm/briq-cli","owner":"nlm","description":"Briq command-line interface","archived":false,"fork":false,"pushed_at":"2023-01-13T15:21:06.000Z","size":50,"stargazers_count":11,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-06-21T00:15:41.849Z","etag":null,"topics":["briq","briq-api"],"latest_commit_sha":null,"homepage":"","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/nlm.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}},"created_at":"2022-06-02T16:02:44.000Z","updated_at":"2022-12-22T16:26:51.000Z","dependencies_parsed_at":"2023-02-09T16:00:26.668Z","dependency_job_id":null,"html_url":"https://github.com/nlm/briq-cli","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/nlm%2Fbriq-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlm%2Fbriq-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlm%2Fbriq-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlm%2Fbriq-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nlm","download_url":"https://codeload.github.com/nlm/briq-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225669584,"owners_count":17505405,"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":["briq","briq-api"],"created_at":"2024-11-21T04:17:53.506Z","updated_at":"2024-11-21T04:17:54.153Z","avatar_url":"https://github.com/nlm.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BRIQ-CLI\n\n### TO START\n ```\n \u003e git clone https://github.com/nlm/briq-cli.git\n \u003e cd briq-cli\n \u003e make\n \u003e ./briq-cli -h\n ```\n\n### CONFIG\n\n- copy the `config.example.yaml` and name it `config.yaml`\n- find your token by inspecting request in briq website (in the `Authorization` header)\n- copy your token and paste it in the `config.yaml`\n- create as much **groups** as you want by adding the usernames of the people you want to send briq to\n\n### COMMANDS\n\n- `give`, `g`\n\n    Give one or more briqs to someone\n    ```\n    \u003e briq-cli give [flags]\n    ```\n    | Flags |  Type | Default value| Explanation | \n    | ------ | :--: | :--: | ------ |\n    | --amount | uint | 1 | How Many briqs to give to the user |\n    | --message | string | \"Have a Briq! #Rock-solid\"| Message to send, must include one #Value |\n    | --to | string | | Username to give to |\n\n- `group-give`, `gg`\n\n    Give one or more briqs to a **group**\n    ```\n    \u003e briq-cli group-give [flags]\n    ```\n\n    | Flags |  Type | Default value| Explanation | \n    | ------ | :--: | :--: | ------ |\n    | --amount | uint | 1 | How Many briqs to give to each user |\n    | --message | string | \"🎁 #Community\"| Message to send, must include one #Value |\n    | --to-group | string | | Limit to a specific group of users |\n\n- `help`\n\n    Help provides help for any command in the application.\n    ```\n    \u003e briq-cli help [path to command]\n    ```\n\n- `list-users`, `lu`\n\n    List info about existing users on briq \n    ```\n    \u003e ./briq-cli lu\n    +---------------------------+--------------------------+------+---------+---------+\n    | USERNAME                  | DISPLAY NAME             |   XP | BALANCE | TO GIVE |\n    +---------------------------+--------------------------+------+---------+---------+\n    | jdupont                   | Jean Dupont              |  42  |     123 |      12 |\n    ...\n    ```\n- `me`, `m`\n\n    Get information about me\n    ```\n    \u003e ./briq-cli me\n    +-----------------+--------------------------------------+\n    | KEY             | VALUE                                |\n    +-----------------+--------------------------------------+\n    | Id              | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |\n    | Username        | jdupont                              |\n    | Full Name       | Jean Dupont                          |\n    | Display Name    | Jean                                 |\n    | Briqs to give   | 12                                   |\n    | Collected Briqs | 123                                  |\n    +-----------------+--------------------------------------+\n    ```\n\n- `random-love`, `rl`\n\n    Send a briq to a number of random users\n    ```\n    \u003e briq-cli random-love [flags]\n    ```\n    | Flags |  Type | Default value| Explanation | \n    | ------ | :--: | :--: | ------ |\n    | --amount | uint | 1 | How Many briqs to give to each user |\n    | --message | string | \"Everybody needs some Briqs #Community\"| Message to send, must include one #Value |\n    | --to-group | string | | Limit to a specific group of users |\n    | --user-count | uint | 3 | Number of users to send briqs to |\n\n\n\n### NOTES:\n- You can only send a maximum of 4 briq to the same user per day\n- You can use `-h`, `--help` for each command to get help\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlm%2Fbriq-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnlm%2Fbriq-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlm%2Fbriq-cli/lists"}