# 4ch

> Limited 4chan API and CLI

Latest version **0.0.2** (published 2019-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install 4ch
pnpm add 4ch
yarn add 4ch
bun add 4ch
```

Provides the command `4ch`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-01-12 |
| First published | 2019-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | @aowlsprit |
| Maintainers | aowlsprit |

## Links

- npm: https://www.npmjs.com/package/4ch
- Repository: https://github.com/aowlsprit/4ch
- npm.io page: https://npm.io/package/4ch

## Dependencies (2)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.1.2
- [html-to-text](https://npm.io/package/html-to-text.md) ^4.0.0

## Recent versions

- 0.0.2 (latest) — 2019-01-12
- 0.0.1 — 2019-01-10

## README

# 4ch
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)

Minimal Node.js API and CLI for getting what you want out of 4chan.

## Installation
```bash
yarn global add 4ch
```
Or if you prefer npm
```
npm install -g 4ch
```

## Commands (CLI)
```
4ch [ls|dl|cat] [options]

DESCRIPTION
  ls -- List all active threads of a given board.
    options: [board]
    example: 4ch list g
  dl -- Download all image/gif/web files of a given thread in a board. Images are downloaded to the `process.cwd()/4ch-out/` folder.
    options: [board, thread]
    example: 4ch dl g 123456789
  cat -- Print all posts of a given thread in a board.
    options: [board, thread]
    example: 4ch cat g 123456789
```

## Usage (API)
```js
const {
  downloadThreadImages,
  getBoardCatalog,
  getThread } = require('4ch')

const threads = await getBoardCatalog('g')
const posts = await getThread('g', '123456789')
const images = await downloadThreadImages('g', '123456789')
```


## Contact
@aowlsprit

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