Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dipakparmar/tweet-bot

🚧 Simple twitter retweet bot [WIP]
https://github.com/dipakparmar/tweet-bot

retweet-bot twitter-bot

Last synced: 28 days ago
JSON representation

🚧 Simple twitter retweet bot [WIP]

Host: GitHub
URL: https://github.com/dipakparmar/tweet-bot
Owner: dipakparmar
License: mit
Created: 2022-04-21T21:49:16.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-04-10T05:09:46.000Z (over 1 year ago)
Last Synced: 2024-09-13T04:32:58.142Z (about 2 months ago)
Topics: retweet-bot, twitter-bot
Language: TypeScript
Homepage: https://npmjs.org/package/@dipakparmar/tweet-bot
Size: 464 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        tweet-bot

=================

Tweet Bot

[![Tweet Bot](https://img.shields.io/badge/tweet--bot-brightgreen.svg)](https://dipakparmar.github.io/tweet-bot/)

[![Version](https://img.shields.io/npm/v/@dipakparmar/tweet-bot.svg)](https://npmjs.org/package/@dipakparmar/tweet-bot)

[![Downloads/week](https://img.shields.io/npm/dw/@dipakparmar/tweet-bot)](https://npmjs.org/package/@dipakparmar/tweet-bot)

[![License](https://img.shields.io/npm/l/@dipakparmar/tweet-bot.svg)](https://github.com/dipakparmar/tweet-bot/blob/main/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g @dipakparmar/tweet-bot

$ tweet-bot COMMAND

running command...

$ tweet-bot (--version)

@dipakparmar/tweet-bot/0.0.2 darwin-x64 node-v16.14.0

$ tweet-bot --help [COMMAND]

USAGE

  $ tweet-bot COMMAND

...

```

# Commands

* [`tweet-bot help [COMMAND]`](#tweet-bot-help-command)

* [`tweet-bot setup`](#tweet-bot-setup)

* [`tweet-bot start`](#tweet-bot-start)

## `tweet-bot help [COMMAND]`

Display help for tweet-bot.

```

USAGE

  $ tweet-bot help [COMMAND] [-n]

ARGUMENTS

  COMMAND  Command to show help for.

FLAGS

  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION

  Display help for tweet-bot.

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_

## `tweet-bot setup`

Configure the tweet-bot server.

```

USAGE

  $ tweet-bot setup [-k ] [-s ] [-t ] [-S ] [-h ] [-f]

FLAGS

  -S, --accessTokenSecret=  Twitter App Access Token Secret

  -f, --force                      Overwrite existing config file

  -h, --searchHashtag=      Hashtag to search

  -k, --consumerKey=        Twitter App Consumer key

  -s, --consumerSecret=     Twitter App Consumer Secret

  -t, --accessToken=        Twitter App Access Token

DESCRIPTION

  Configure the tweet-bot server.

EXAMPLES

  $ tweet-bot setup

```

_See code: [dist/commands/setup.ts](https://github.com/dipakparmar/tweet-bot/blob/v0.0.2/dist/commands/setup.ts)_

## `tweet-bot start`

Start the tweet-bot server.

```

USAGE

  $ tweet-bot start

DESCRIPTION

  Start the tweet-bot server.

EXAMPLES

  $ tweet-bot start

```

_See code: [dist/commands/start.ts](https://github.com/dipakparmar/tweet-bot/blob/v0.0.2/dist/commands/start.ts)_