chuckle-cli

chuckle-cli is a command-line application that prints out a random joke. It utilises an API from 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.

Preview

Note

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.

Installation

Dependencies

Go: Make sure you have Go installed on your system. You can download and install it from https://golang.org/dl/.
Git: Make sure you have Git installed to clone the repository. You can download and install it from https://git-scm.com/downloads.

Clone the repository

Open your terminal or command prompt and clone the repository using Git:

git clone https://github.com/seburbandev/chuckle-cli.git

Mac/Linux installation

Open your terminal and navigate to the cloned repository directory if you haven't already done so:
```
cd chuckle-cli
```
Run the setup script:
```
./unix-setup.sh
```
Restart your terminal to apply changes.

Windows installation

Open command prompt or powershell with administrator rights and navigate to the cloned repository directory if you haven't already done so:
```
cd chuckle-cli
```
Run the setup script:
```
.\windows-setup.ps1
```
Restart your terminal to apply changes.

Usage

Once you have installed chuckle-cli, you can use the chuckle command to fetch and display a random joke:

chuckle

You should see joke printed in a format like below:

Have you ever heard of a music group called Cellophane?
...

...

...
They mostly wrap.

Flags

Specifying a joke type

chuckle -type programming

The above will fetch a random joke of type programming

Checking available joke types

chuckle -list-types

You should see the following:

Available joke types:
general
knock-knock
programming
dad

Troubleshooting

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.
Ensure you have restarted your terminal or sourced the shell configuration file after running the setup script.

Contributing

Contributions are welcome. Please open an issue or submit a pull request for any improvements or bug fixes.

License

The MIT License (MIT)

Copyright (c) 2024-present Sebastian Urban

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.