# ypb

> 🤖 Meta's Threads bot that posts current ⌚ `year progress bar` updates.

Latest version **1.0.0-beta.2** (published 2024-01-25) · MIT license · 0 weekly downloads

## Install

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

Provides the commands `ypb`, `yearprogressbar`.

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.2 |
| Published | 2024-01-25 |
| First published | 2024-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Marc Redwerkz |
| Maintainers | redwerkz |
| Keywords | meta, instagram, threads, bot, threads-bot, threads-api, threads-client |

## Links

- npm: https://www.npmjs.com/package/ypb
- Repository: https://github.com/rdwz/yearprogbar
- Homepage: https://github.com/rdwz/yearprogbar#readme
- Issues: https://github.com/rdwz/yearprogbar/issues
- npm.io page: https://npm.io/package/ypb

## Dependencies (6)

- [cron](https://npm.io/package/cron.md) ^3.1.6
- [boxen](https://npm.io/package/boxen.md) ^5.1.2
- [dayjs](https://npm.io/package/dayjs.md) ^1.11.10
- [dotenv](https://npm.io/package/dotenv.md) ^16.4.1
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [threads-api](https://npm.io/package/threads-api.md) ^1.6.3

## Recent versions

- 1.0.0-beta.2 (latest) — 2024-01-25
- 1.0.0-beta — 2024-01-25

## README

# YearProgressBar

[![npm version](https://img.shields.io/npm/v/ypb?style=flat-square)](https://www.npmjs.com/package/ypb)
[![install size](https://packagephobia.com/badge?p=ypb&style=flat-square)](https://packagephobia.com/result?p=ypb)
[![license](https://img.shields.io/github/license/rdwz/yearprogbar?style=flat-square)](https://github.com/rdwz/yearprogbar)
[![style: ts-standard](https://badgen.net/badge/style/ts-standard/f3df49)][ts-standard]

> Meta's Threads bot that posts current year progress bar updates.

**_See it in action on [@yearprogbar](https://www.threads.net/@yearprogbar) 🙌_**

## Highlights

- Written in TypeScript
- Uses [Reverse-Engineered Threads API](https://github.com/junhoyeo/threads-api) underneath

## Install

```sh
npm install -g ypb
```

## Usage

```sh
ypb [options]
```

### Options

- `-u, --username <username>`: threads username.
- `-p, --password <password>`: threads password.
- `-f, --force`: (optional) force post the current progress (default: false)
- `-d, --debug`: (optional) run in local, console.log only mode (default: false)
- `-V, --version`: output the version number
- `-h, --help`: display help for command

## Examples

1. Run the program:

    ```sh
    ypb -u <username> -p <password>
    ```

2. Post the current year progress when starting the program:

    ```sh
    ypb -u <username> -p <password> -f
    ```

3. Post the current year progress on start while running in debug mode:

    ```sh
    $ ypb -u <username> -p <password> -f -d

    ╭────── 25.01.2024 19:01 ──────╮
    │                              │
    │   ⌚ 2024 is 6% complete    │
    │   ▓░░░░░░░░░░░░░░░░░░░░░░░   │
    │                              │
    ╰──────────────────────────────╯
    ```

### Toolchain

- Biome <https://biomejs.dev>
- Bun <https://bun.sh>
- TS-Standard <https://www.npmjs.com/package/ts-standard>
- tsup <https://tsup.egoist.dev/>

[ts-standard]: https://standardjs.com/#typescript

## Others

- <https://www.threads.net/@yearprogress>
- <https://www.threads.net/@yearprog>

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