https://github.com/vikiboss/chatee

A terminal chat app, powered by React, ink, and icqq.
https://github.com/vikiboss/chatee

chat icqq oicq

Last synced: about 1 month ago
JSON representation

A terminal chat app, powered by React, ink, and icqq.

• Host: GitHub
• URL: https://github.com/vikiboss/chatee
• Owner: vikiboss
• Created: 2024-07-02T02:04:17.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-25T08:02:49.000Z (5 months ago)
• Last Synced: 2024-11-07T20:11:02.491Z (about 2 months ago)
• Topics: chat, icqq, oicq
• Language: TypeScript
• Homepage:
• Size: 84 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Chatee

A terminal chat app, powered by [`React`](https://react.dev/), [`ink`](https://github.com/vadimdemedes/ink), and [`icqq`](https://github.com/icqqjs/icqq) (private repo, join [icqqjs](https://github.com/icqqjs) org first to use it).

## Setup

1. Get **GitHub Organization Access Token** from [icqqjs](https://github.com/icqqjs).

2. Set scope config and token in global `.npmrc` file (such as `~/.npmrc`).

> Please replace `` with your token.

```shell

echo "@icqqjs:registry=https://npm.pkg.github.com" >> ~/.npmrc

echo "//npm.pkg.github.com/:_authToken=" >> ~/.npmrc

```

3. Run Chatee

```tsx

npx chatee

// or use specific env

// CHATEE_SIGN_API= CHATEE_PLATFORM= CHATEE_UIN= npx chatee

```

## Usage

- Press `⬆️` & `⬇️` to navigate.

- Press `Tab` to return home.

- Press `Ctrl C` to exit.

- **Filter** feature at **Friends and Groups** page is supported.

## Env Description

- `CHATEE_SIGN_API`: Sign API for `icqq`

- `CHATEE_PLATFORM`: Platform for `icqq`

- `CHATEE_UIN`: Account/uin for `icqq`

## Data & Config

- Chatee Dir: `/.config/chatee`

- Chatee Config: `/.config/chatee/chatee.json`

## License

MIT (c) 2024 Viki