# cliboards

> ⌨️ Surf your online communities on CLI

Latest version **1.0.0-beta.125** (published 2021-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install cliboards
pnpm add cliboards
yarn add cliboards
bun add cliboards
```

Provides the command `cliboards`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.125 |
| Published | 2021-03-25 |
| First published | 2020-05-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.18.1 |
| Dependencies | 7 |
| Unpacked size | 185.4 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Sam Noh |
| Maintainers | samnoh |
| Keywords | cli, terminal, surfing, korea, korean, online, community, viewer, crawler, scraper |

## Links

- npm: https://www.npmjs.com/package/cliboards
- Repository: https://github.com/samnoh/cliboards
- Issues: https://github.com/samnoh/cliboards/issues
- npm.io page: https://npm.io/package/cliboards

## Dependencies (7)

- [open](https://npm.io/package/open.md) 7.2.0
- [axios](https://npm.io/package/axios.md) 0.21.1
- [blessed](https://npm.io/package/blessed.md) 0.1.81
- [minimist](https://npm.io/package/minimist.md) 1.2.5
- [puppeteer](https://npm.io/package/puppeteer.md) 5.2.1
- [configstore](https://npm.io/package/configstore.md) 5.0.1
- [update-notifier](https://npm.io/package/update-notifier.md) 4.1.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.0-beta.125 (latest) — 2021-03-25
- 1.0.0-beta.124 — 2021-03-18
- 1.0.0-beta.123 — 2021-01-27
- 1.0.0-beta.122 — 2020-09-03
- 1.0.0-beta.121 — 2020-09-03
- 1.0.0-beta.120 — 2020-08-20
- 1.0.0-beta.119 — 2020-08-17
- 1.0.0-beta.118 — 2020-08-13
- 1.0.0-beta.117 — 2020-08-10
- 1.0.0-beta.116 — 2020-08-10
- 1.0.0-beta.115 — 2020-08-03
- 1.0.0-beta.114 — 2020-08-03
- 1.0.0-beta.113 — 2020-08-03
- 1.0.0-beta.112 — 2020-07-31
- 1.0.0-beta.111 — 2020-07-31
- … 111 more at https://npm.io/package/cliboards/versions

## README

# cliboards · [![Made with Node.js](https://img.shields.io/badge/Made%20with-Node.js-darkgreen)](https://nodejs.org) [![npm version](https://img.shields.io/npm/v/cliboards)](https://www.npmjs.com/package/cliboards) [![npm downloads](https://img.shields.io/npm/dt/cliboards?color=red)](https://npm-stat.com/charts.html?package=cliboards) [![GitHub last commit](https://img.shields.io/github/last-commit/samnoh/cliboards?color=blue)](https://github.com/samnoh/cliboards/commits/master) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/samnoh/cliboards/Node.js%20CI)](https://github.com/samnoh/cliboards/actions?query=workflow%3A%22Node.js+CI%22)

> ⌨️ Surf your online communities on CLI

![screenshot](.github/img/screenshot-01.jpg)

## Features

-   Browse online communities: `Clien`, `dcinside`, `DVDPrime`, `Ruliweb`, `PPOMPPU` and `SLRClub`
-   Post favorites
-   Post history
-   Search posts
-   Shurtcut for viewing images on default web browser
-   Hides screen instantly (`space` key)
-   May load faster with a slow internet connection
-   Spoiler protection
-   Color customizations
-   Filters posts by keywords

## Installation

Use the package manager [npm](https://www.npmjs.com) to install `cliboards`.

```bash
# Install globally (highly recommended) or update to the latest version
npm i -g cliboards

# Or run directly (installs CLI on every run).
npx cliboards
```

## Usage

```bash
# Display a list of community
cliboards

# Display the nth community (1 is the first)
cliboards <index>

# Display community for given name (non-case sensitive)
cliboards <name>

# Reset all data including favorites
cliboards --reset

# Reset favorites
cliboards --resetFav

# Reset data for given community only
cliboards <index|name> --reset

# Reset favorites for given community only
cliboards <index|name> --resetFav

# Update theme (color customizations)
cliboards --theme

# Update post filters by keywords
cliboards --filter

# Disable spoiler protection
cliboards --showSpoiler

# Hide comments in order to browse posts faster
cliboards --hideComments

# Show/hide top and/or bottom bars
cliboards --fullScreen
cliboards --hideTopBar
cliboards --hideBottomBar
```

## Changelog

[Read the changelog here](CHANGELOG.md)

## Contributing

Please do contribute! Issues and pull requests are all welcome.

### Code of Conduct

Please read the [full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

## Licnese

[MIT licensed](LICENSE)

---
_Source: https://npm.io/package/cliboards · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._