https://github.com/samnoh/cliboards

⌨️ Surf your online communities on CLI
https://github.com/samnoh/cliboards

cli-application crawler javascript

Last synced: 2 months ago
JSON representation

⌨️ Surf your online communities on CLI

• Host: GitHub
• URL: https://github.com/samnoh/cliboards
• Owner: samnoh
• License: mit
• Created: 2020-03-17T09:40:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-06-15T06:57:29.000Z (10 months ago)
• Last Synced: 2025-08-23T08:09:16.748Z (7 months ago)
• Topics: cli-application, crawler, javascript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cliboards
• Size: 3.87 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

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 

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

cliboards 

# Reset all data including favorites

cliboards --reset

# Reset favorites

cliboards --resetFav

# Reset data for given community only

cliboards  --reset

# Reset favorites for given community only

cliboards  --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)