Sv443 9d359667bb fix: replace substr with substring 1 month ago
..
README.md dc8b06fb76 feat: push more 5 months ago
add-joke.js 9d359667bb fix: replace substr with substring 1 month ago
add-token.js dc8b06fb76 feat: push more 5 months ago
cli.js dc8b06fb76 feat: push more 5 months ago
generate-changelog.js 15935703b2 ref: replace old repo link 1 month ago
info.js dc8b06fb76 feat: push more 5 months ago
reassign-ids.js dc8b06fb76 feat: push more 5 months ago
reformat.js dc8b06fb76 feat: push more 5 months ago
submissions.js 9d359667bb fix: replace substr with substring 1 month ago
test.js dc8b06fb76 feat: push more 5 months ago
types.d.ts dc8b06fb76 feat: push more 5 months ago
validate-ids.js 9d359667bb fix: replace substr with substring 1 month ago
validate-jokes.js dc8b06fb76 feat: push more 5 months ago

README.md

JokeAPI CLI tools

Since v2.3.2, JokeAPI has a globally callable command line binary, which acts as an interface to all command-line tools inside this ./tools folder.


Setup:

To register the JokeAPI binary, run the command npm run link
If you get an EACCES error, try using sudo npm run link, otherwise you probably need to reinstall Node.js through a version manager like nvm

Afterwards, the binary will be globally callable with the commands jokeapi and japi

To display a list of all commands, run jokeapi -h
To get command-specific help and show the command's arguments, run jokeapi -h <command>


Commands:

Command Description
jokeapi start Starts JokeAPI (equivalent to running npm start or node .)
jokeapi info Prints information about JokeAPI, like the /info endpoint