{"id":33185687,"url":"https://github.com/seburbandev/chuckle-cli","last_synced_at":"2025-11-22T04:01:30.449Z","repository":{"id":252693214,"uuid":"840503833","full_name":"seburbandev/chuckle-cli","owner":"seburbandev","description":"chuckle-cli is a command-line application that utilises an API in order to print out jokes in your terminal","archived":false,"fork":false,"pushed_at":"2024-08-24T15:48:41.000Z","size":154,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-25T12:30:12.127Z","etag":null,"topics":[],"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/seburbandev.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}},"created_at":"2024-08-09T21:31:10.000Z","updated_at":"2024-08-24T15:37:15.000Z","dependencies_parsed_at":"2024-08-24T12:40:09.985Z","dependency_job_id":null,"html_url":"https://github.com/seburbandev/chuckle-cli","commit_stats":null,"previous_names":["seburbandev/chuckle-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/seburbandev/chuckle-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seburbandev%2Fchuckle-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seburbandev%2Fchuckle-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seburbandev%2Fchuckle-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seburbandev%2Fchuckle-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seburbandev","download_url":"https://codeload.github.com/seburbandev/chuckle-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seburbandev%2Fchuckle-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285731803,"owners_count":27222214,"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-11-22T02:00:05.934Z","response_time":64,"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":[],"created_at":"2025-11-16T05:00:20.099Z","updated_at":"2025-11-22T04:01:30.438Z","avatar_url":"https://github.com/seburbandev.png","language":"Go","funding_links":[],"categories":["\u003ca name=\"online\"\u003e\u003c/a\u003eOnline search and resources"],"sub_categories":[],"readme":"# chuckle-cli\n\nchuckle-cli is a command-line application that prints out a random joke. It utilises an API from [15DKatz/official_joke_api](https://github.com/15Dkatz/official_joke_api). You can install it on Windows, Mac or Linux. Once installed, everytime you're in terminal, you can type `chuckle` and it will print out a joke, so you can have a chuckle. \n\n## Preview\n\n![](./chuckle-cli.gif)\n\n\u003e [!NOTE]\n\u003e This app was created as a fun project to learn more about the Go programming language. If you have any cool ideas for new features or integrations, raise an issue and I'll see what I can do.\n\n## Installation\n\n### Dependencies\n\n- **Go**: Make sure you have Go installed on your system. You can download and install it from [https://golang.org/dl/](https://golang.org/dl/).\n- **Git**: Make sure you have Git installed to clone the repository. You can download and install it from [https://git-scm.com/downloads](https://git-scm.com/downloads).\n\n### Clone the repository\n\nOpen your terminal or command prompt and clone the repository using Git:\n\n```sh\ngit clone https://github.com/seburbandev/chuckle-cli.git\n```\n\n### Mac/Linux installation\n\n1. Open your terminal and navigate to the cloned repository directory if you haven't already done so:\n\n    ```sh\n    cd chuckle-cli\n    ```\n\n2. Run the setup script:\n\n    ```sh\n    ./unix-setup.sh\n    ```\n\n3. Restart your terminal to apply changes.\n\n### Windows installation\n\n1. Open command prompt or powershell with administrator rights and navigate to the cloned repository directory if you haven't already done so:\n\n    ```sh\n    cd chuckle-cli\n    ```\n\n2. Run the setup script:\n\n    ```sh\n    .\\windows-setup.ps1\n    ```\n\n3. Restart your terminal to apply changes.\n\n## Usage\n\nOnce you have installed `chuckle-cli`, you can use the `chuckle` command to fetch and display a random joke:\n\n```sh\nchuckle\n```\n\nYou should see joke printed in a format like below:\n\n```\nHave you ever heard of a music group called Cellophane?\n...\n\n...\n\n...\nThey mostly wrap.\n```\n\n## Flags\n\n### Specifying a joke type\n\n```sh\nchuckle -type programming\n```\n\nThe above will fetch a random joke of type programming\n\n### Checking available joke types\n\n```\nchuckle -list-types\n```\n\nYou should see the following:\n\n```\nAvailable joke types:\ngeneral\nknock-knock\nprogramming\ndad \n```\n\n## Troubleshooting\n\n- If the `chuckle` command is not recognized after installation, ensure that the PATH has been updated correctly by checking your shell configuration file (e.g., `.zshrc`, `.bash_profile`) and verifying that the `chuckle-cli` directory is included in your PATH.\n- Ensure you have restarted your terminal or sourced the shell configuration file after running the setup script.\n\n## Contributing\n\nContributions are welcome. Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## License\n\n```\nThe MIT License (MIT)\n\nCopyright (c) 2024-present Sebastian Urban\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseburbandev%2Fchuckle-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseburbandev%2Fchuckle-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseburbandev%2Fchuckle-cli/lists"}