joke

README

joke

guaranteed to make your day better, or your money back!

use

# installs joke in your $HOME/go/bin, make sure this directory is in your $PATH
$ go get github.com/gabrie30/joke
# sets up the sqlite database in $HOME/.joke.db
$ joke db setup
# tell one joke
$ joke
# tell many jokes
$ joke --count 2
# tell the last 5 jokes fetched
$ joke --last 5
# get help
$ joke --help

for best results add joke to .zshrc, .bashrc, etc. :trollface:

getting new jokes

New jokes are fetched only once per day, this is to increase performance which helps if joke is added to .zshrc or similar. However, you can fetch jokes manually by running joke fetch

TIP: Seed your database with over 5000 jokes, download here and replace with your $HOME/.joke.db

database

The datastore is an SQLite database located at $HOME/.joke.db. It's is created upon running joke db setup.

viewing data

Open the database

$ sqlite3 $HOME/.jokes.db
sqlite> select * from jokes;

TIP: add the following to your $HOME/.sqliterc for easier to read queries

.mode column
.headers on
.separator ROW "\n"
.nullvalue NULL

content

Jokes are scraped from reddits /r/jokes. Any joke labeled 18+ is excluded from collection by default, however this does not mean all jokes collected are of good taste. Use at your own discretion.

troubleshooting

• Make sure $HOME/go/bin is in your $PATH go env | grep GOBIN if not, you'll need to set it or put $HOME/go/bin/joke somewhere in your $PATH
  • To add $HOME/go/bin to your path export PATH="$PATH:$HOME/go/bin"

Documentation

Overview

Copyright © 2019 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.