https://github.com/pforret/shwiki

Wikipedia CLI in bash
https://github.com/pforret/shwiki

bash bashew wikipedia-api

Last synced: 7 months ago
JSON representation

Wikipedia CLI in bash

• Host: GitHub
• URL: https://github.com/pforret/shwiki
• Owner: pforret
• License: mit
• Created: 2022-04-24T19:14:39.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-24T22:39:25.000Z (over 3 years ago)
• Last Synced: 2025-01-13T22:22:00.696Z (9 months ago)
• Topics: bash, bashew, wikipedia-api
• Language: Shell
• Homepage:
• Size: 940 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![bash_unit CI](https://github.com/pforret/shwiki/workflows/bash_unit%20CI/badge.svg)

![Shellcheck CI](https://github.com/pforret/shwiki/workflows/Shellcheck%20CI/badge.svg)

![GH Language](https://img.shields.io/github/languages/top/pforret/shwiki)

![GH stars](https://img.shields.io/github/stars/pforret/shwiki)

![GH tag](https://img.shields.io/github/v/tag/pforret/shwiki)

![GH License](https://img.shields.io/github/license/pforret/shwiki)

[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://www.basher.it/package/)

# shwiki

Wikipedia CLI in bash

![](assets/unsplash.encyclopedia.jpg)

## 🔥 Usage

```

Program: shwiki 1.0.3 by peter@forret.com

Updated: Apr 24 23:47:08 2022

Description: Wikipedia CLI in bash

Usage: shwiki [-h] [-q] [-v] [-c] [-f] [-l ] [-t ] [-w ] [-p ] [-s ]  

Flags, options and parameters:

    -h|--help        : [flag] show usage [default: off]

    -q|--quiet       : [flag] no output [default: off]

    -v|--verbose     : [flag] output more [default: off]

    -c|--cleanup     : [flag] cleanup Wikipedia text [default: off]

    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]

    -l|--log_dir > : [option] folder for log files   [default: /Users/pforret/log/shwiki]

    -t|--tmp_dir > : [option] folder for temp files  [default: /Users/pforret/Code/Github/shwiki/.tmp]

    -w|--width >   : [option] max line width  [default: 100]

    -p|--paragraphs >: [option] stop after N paragraphs  [default: 1]

    -s|--sentences >: [option] stop after N sentences  [default: 10]

             : [choice] action to perform  [options: search,action2,check,env,update]

              : [parameter] search term (optional)

```

## ⚡️ Examples

```bash

> shwiki search London

# get Wikipedia information about London

> shwiki -p 2 -s 10 -c search London

# get Wikipedia information about London, max 2 paragraphs, max 10 sentences, and clean up the text

```

## 🚀 Installation

with [basher](https://github.com/basherpm/basher)

	$ basher install pforret/shwiki

or with `git`

	$ git clone https://github.com/pforret/shwiki.git

	$ cd shwiki

## 📝 Acknowledgements

* script created with [bashew](https://github.com/pforret/bashew)

© 2022 Peter Forret