# horus-twitter

> A lightweight Twitter CLI

Latest version **0.1.1** (published 2019-01-23) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install horus-twitter
pnpm add horus-twitter
yarn add horus-twitter
bun add horus-twitter
```

Provides the command `horus`.

## 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.1.1 |
| Published | 2019-01-23 |
| First published | 2019-01-23 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jeff Nabors |
| Maintainers | rkdnc |

## Links

- npm: https://www.npmjs.com/package/horus-twitter
- Repository: https://github.com/rkdnc/horus
- Homepage: https://github.com/rkdnc/horus#readme
- Issues: https://github.com/rkdnc/horus/issues
- npm.io page: https://npm.io/package/horus-twitter

## Dependencies (5)

- [twit](https://npm.io/package/twit.md) ^2.2.11
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [dotenv](https://npm.io/package/dotenv.md) ^6.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.1
- [commander](https://npm.io/package/commander.md) ^2.19.0

## Recent versions

- 0.1.1 (latest) — 2019-01-23

## README

Horus is an easy-to-use Twitter client in the terminal, built in Node.js with Commander. Inspired by [t by sferik](https://github.com/sferik/t)


## How to set up Horus for your account.

Once Horus is running, type `setup` to begin the setup process to enter your API keys from Twitter. You will need to sign up [here](https://developer.twitter.com/en/apps),
signing up with your Twitter account and creating a new App in order to generate your API keys. 

## Usage

Horus' functionality is based off Twitter's SMS commands found [here](https://help.twitter.com/en/using-twitter/sms-commands). Some have been omitted due to the inability to translate from SMS to terminal (such as notifications).

Any command with `<>` is a required parameter, and must be included with your command for it to execute. Commands with `[]` are optional parameters, which will have built-in defaults.

### `timeline [num]`

Displays your home timeline, showing the oldest descending. You can optionally add a number of tweets to view, with the default being 10. 

### `post <text>`

Posts a tweet (up to 280 characters). 

### `follow <username>`

Sets your account to follow an account with that username, enabling their tweets to show in your timeline.

### `unfollow <username>`

Sets your account to no longer follow that user, and you will not receive their tweets in your timeline.

### `d <username> <message>`

You will send a direct message to that user. There is no character limit for direct messages.

### `rt <username>`

This will retweet the most recent tweet by the given user.

### `like <username>`

This will 'like' the most recent tweet by the given user.

### `stats <username>`

This returns the given user's bio, the number of followers they have, and the number of people they are following.

### `search <query> [count]`

Searches public tweets for the given query. It will default to the first ten results, unless a number is specified after the query.

### Libraries Used

[Commander.js](https://github.com/tj/commander.js)

[Chalk](https://github.com/chalk/chalk)

[Inquirer.js](https://github.com/SBoudrias/Inquirer.js)

[Twit](https://github.com/ttezel/twit)

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