Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/raulil/redgit

Git like interface for Reddit
https://github.com/raulil/redgit

cli reddit reddit-client

Last synced: about 1 month ago
JSON representation

Git like interface for Reddit

Host: GitHub
URL: https://github.com/raulil/redgit
Owner: RauliL
License: mit
Created: 2021-01-11T14:24:45.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-01-29T10:56:51.000Z (almost 4 years ago)
Last Synced: 2024-10-28T14:50:47.552Z (about 2 months ago)
Topics: cli, reddit, reddit-client
Language: TypeScript
Homepage: https://rauli.dev/redgit
Size: 136 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        redgit

======

Git like interface for Reddit.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/redgit.svg)](https://npmjs.org/package/redgit)

[![Downloads/week](https://img.shields.io/npm/dw/redgit.svg)](https://npmjs.org/package/redgit)

[![License](https://img.shields.io/npm/l/redgit.svg)](https://github.com/RauliL/redgit/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g redgit

$ redgit init

$ redgit log --ordering=new --limit 5 wallstreetbets

```

# Commands

* [`redgit config [KEY] [VALUE]`](#redgit-config-key-value)

* [`redgit downvote ID`](#redgit-downvote-id)

* [`redgit help [COMMAND]`](#redgit-help-command)

* [`redgit init`](#redgit-init)

* [`redgit log [SUBREDDIT]`](#redgit-log-subreddit)

* [`redgit open ID`](#redgit-open-id)

* [`redgit reply ID`](#redgit-reply-id)

* [`redgit show ID`](#redgit-show-id)

* [`redgit subscription [COMMAND] [SUBREDDIT]`](#redgit-subscription-command-subreddit)

* [`redgit upvote ID`](#redgit-upvote-id)

## `redgit config [KEY] [VALUE]`

manage RedGit configuration

```

USAGE

  $ redgit config [KEY] [VALUE]

ARGUMENTS

  KEY    name of the variable to get/set

  VALUE  new value of the variable

OPTIONS

  -e, --edit               opens the configuration file in text editor

  -l, --list               list all

  --get=get                get value: name

  --get-regexp=get-regexp  get values for regexp: name-regex

  --unset=unset            remove a variable: name

```

_See code: [src/commands/config.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/config.ts)_

## `redgit downvote ID`

downvotes an submission

```

USAGE

  $ redgit downvote ID

ARGUMENTS

  ID  id of the submission to downvote

```

_See code: [src/commands/downvote.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/downvote.ts)_

## `redgit help [COMMAND]`

display help for redgit

```

USAGE

  $ redgit help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

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

## `redgit init`

initializes RedGit with Reddit authentication tokens

```

USAGE

  $ redgit init

```

_See code: [src/commands/init.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/init.ts)_

## `redgit log [SUBREDDIT]`

list submissions

```

USAGE

  $ redgit log [SUBREDDIT]

ARGUMENTS

  SUBREDDIT  subreddit to list submissions from

OPTIONS

  -l, --limit=limit                                limit the number of listed submissions

  -o, --ordering=controversial|hot|new|rising|top  [default: hot] ordering of submissions

  -t, --time=all|hour|day|month|week|year

```

_See code: [src/commands/log.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/log.ts)_

## `redgit open ID`

opens URL of an submission in browser

```

USAGE

  $ redgit open ID

ARGUMENTS

  ID  id of the submission to open

```

_See code: [src/commands/open.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/open.ts)_

## `redgit reply ID`

replies to an submission

```

USAGE

  $ redgit reply ID

ARGUMENTS

  ID  id of the submission to reply to

OPTIONS

  -m, --message=message  message to send as an reply

```

_See code: [src/commands/reply.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/reply.ts)_

## `redgit show ID`

display single submission

```

USAGE

  $ redgit show ID

ARGUMENTS

  ID  id of the submission to display

```

_See code: [src/commands/show.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/show.ts)_

## `redgit subscription [COMMAND] [SUBREDDIT]`

manage subreddit subscriptions

```

USAGE

  $ redgit subscription [COMMAND] [SUBREDDIT]

ARGUMENTS

  COMMAND    (add|rm)

  SUBREDDIT  name of subreddit (without /r/ prefix)

```

_See code: [src/commands/subscription.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/subscription.ts)_

## `redgit upvote ID`

upvotes an submission

```

USAGE

  $ redgit upvote ID

ARGUMENTS

  ID  id of the submission to upvote

```

_See code: [src/commands/upvote.ts](https://github.com/RauliL/redgit/blob/v0.3.0/src/commands/upvote.ts)_