Messer - GitLite

KO | EN

gitlite — search

#ai #typescript #llm #golang #go #android #nodejs #windows #awesome #awesome-list #security #mcp #ios #openai

Messer

(★ 452)

:speech_balloon: Command-line messaging for Facebook Messenger

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - Feature_request.md
- - main.yml
- messer_cli_demo.gif
- index.js
- - clear.js
  - command.template.js
  - contacts.js
  - delete.js
  - file.js
  - help.js
  - history.js
  - index.js
  - lock.js
  - logout.js
  - message.js
  - mute.js
  - recent.js
  - reply.js
  - settings.js
  - threads.js
  - unlock.js
  - unmute.js
- - event.js
  - index.js
  - message.js
  - message_reaction.js
  - read_receipt.js
  - typ.js
- - index.js
  - lock.js
  - repl.js
  - settings.js
- - helpers.js
  - logger.js
- - test.txt
- messer.mock.js
- test.js
.eslintignore
.eslintrc
.gitignore
.npmignore
.prettierignore
.prettierrc
CONTRIBUTING.md
index.js
LICENSE
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/mjkaufer/Messer

Downloads the entire project code from GitHub to your computer.

cd Messer

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install -g messer

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Messer

Command-line Messaging for Facebook Messenger

![Downloads](https://img.shields.io/npm/dm/messer.svg)
![Version](https://img.shields.io/npm/v/messer.svg)
![License](https://img.shields.io/npm/l/messer.svg)

Messer is a rich Facebook Messenger client for your terminal. Send and receive messages, view chat historys and more!

![demo](https://raw.githubusercontent.com/mjkaufer/Messer/master/assets/messer_cli_demo.gif)

## Installation

```bash
$ npm install -g messer
```

## Quick Start

> `node` version 12.x required

1. Install `messer`
2. Run `messer`

```bash
   $ messer
   ```

3. Enter your login details (don't worry, we don't store a thing)

## FAQ

### Do you store any of my data?

**_We don't store your username, password, or any of your interactions on Messer_**.

The only thing we store is a temporary login token when you first log in. This let's us authenticate you with Facebook _without_ you having to enter your username and password every time. If you want to get rid of it, simply run `messer cleanup`, or if you're in a Messer session, run the `logout` command.

### Can I use a deactivated Facebook account?

No, unforunately not. If you use Messer with a deactivated Facebook account, your account will be reactivated.

### How do group chats work?

Messages from group chats appear like

```bash
(My cool friends) John Smith - hey guys!!$$@@
```

Send a message to a group by using the `message` command. The `name` is the name of the group chat! Reply works as normal

## Commands Reference

#### `message`

Sends a _message_ to a given _user_

```bash
(message | m) "<user>" <message>
```

Examples

- `message "Matthew" hello world!`
- `m "Matthew" hello world!`

When sending a message, Messer picks the closest match to what you type in as `user`. For this reason, you should probably use last names if you want to avoid accidentally texting someone.

#### `reply`

Replys to the last message you recevied i.e. Sends a message to the user of the most recently received message.

```bash
(reply | r) <message>
```

Example

- `r "hey yo this is my reply"`

Note: this will only work if you have received at least one message through Messer.

#### `contacts`

Lists all of your Facebook friends

```bash
contacts
```

#### `history`

Displays the last _n_ messages in the conversation with a given user. The number of messages to retrieve are optional (default is 5).

```bash
(history | h) "<user>" [<n>]
```

Examples

- `history "Matthew" 10`
- `h "Matthew"`

#### `recent`

Displays the _n_ most recent conversations. The number of threads is optional (default is 5).
The `--history` option will display the 5 most recent messages in each thread.

```bash
recent [<n>] [--history]
```

Examples

- `recent`
- `recent 10`
- `recent --history`

#### `clear`

Clears the number of unread messages in the window title. Since we cannot listen on focus events, it has to be done manually.

```bash
(clear | c)
```

#### `logout`

Logs you out

```bash
logout
```

#### `mute`

Mutes a thread. If no seconds are specified, the thread is muted indefinetely.

```bash
mute "<thread-name>" [seconds]
```

#### `unmute`

Unmutes a thread

```bash
unmute "<thread-name>"
```

#### `settings`

Configure your user settings on Messer

```bash
settings (set | get | list) [<key>=<value>]
```

Examples

- `settings list`
- `settings get SHOW_READ`
- `settings set SHOW_READ=true`

For supported settings, see section below

### Supported Settings

- `SHOW_READ`
  - Marks conversation as "read" when using `clear` command

### Lock-on Mode

Locking on to a user or group allows you to send messages without having to specify the `message` command; just type away!

```bash
lock "Tom Q"
```

**To unlock**, simply run:

```bash
--unlock
```

### Secret Mode

When in this mode, any messages sent or recieved in the thread will be deleted for you (note, **they won't be deleted for everyone**).

```bash
lock "Tom Q" --secret
```

### Non-interactive Mode

Messer can be run in non-interactive mode with command line arguments to execute a single command.

```bash
messer --command='<command>'
```

Login will be prompted if this is the first time logging in.

Examples

- `messer --command='m "John Smith" Hey, John'`
- `messer --command='r Hey, John'`

### Cleanup

If ever you want to clean up any old Messer sessions and start from scratch, run:

```bash
$ messer cleanup
```

## Contributing

Want to add a new command, fix a bug or improve Messer in another way? Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

## License

This project is licensed under the ISC License - see the LICENSE file for details