Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/geowarin/ttytube

CLI to play youtube videos from the console (no API key required)
https://github.com/geowarin/ttytube

react-ink youtube-dl

Last synced: about 4 hours ago
JSON representation

CLI to play youtube videos from the console (no API key required)

Awesome Lists containing this project

README

        

ttytube
=======

CLI viewer for youtube

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/ttytube.svg)](https://npmjs.org/package/ttytube)
[![CircleCI](https://circleci.com/gh/geowarin/ttytube/tree/master.svg?style=shield)](https://circleci.com/gh/geowarin/ttytube/tree/master)
[![Downloads/week](https://img.shields.io/npm/dw/ttytube.svg)](https://npmjs.org/package/ttytube)
[![License](https://img.shields.io/npm/l/ttytube.svg)](https://github.com/geowarin/ttytube/blob/master/package.json)

* [Usage](#usage)
* [Commands](#commands)

# Usage

```sh-session
$ npm install -g ttytube
$ ttytube COMMAND
running command...
$ ttytube (-v|--version|version)
ttytube/0.0.0 linux-x64 node-v15.6.0
$ ttytube --help [COMMAND]
USAGE
$ ttytube COMMAND
...
```

# Commands

* [`ttytube dump [FILE]`](#ttytube-dump-file)
* [`ttytube hello [FILE]`](#ttytube-hello-file)
* [`ttytube help [COMMAND]`](#ttytube-help-command)
* [`ttytube play [VIDEOID]`](#ttytube-play-videoid)
* [`ttytube search [SEARCH]`](#ttytube-search-search)

## `ttytube dump [FILE]`

describe the command here

```
USAGE
$ ttytube dump [FILE]

OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```

_See code: [src/commands/dump.ts](https://github.com/geowarin/ttytube/blob/v0.0.0/src/commands/dump.ts)_

## `ttytube hello [FILE]`

describe the command here

```
USAGE
$ ttytube hello [FILE]

OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print

EXAMPLE
$ ttytube hello
hello world from ./src/hello.ts!
```

_See code: [src/commands/hello.ts](https://github.com/geowarin/ttytube/blob/v0.0.0/src/commands/hello.ts)_

## `ttytube help [COMMAND]`

display help for ttytube

```
USAGE
$ ttytube 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)_

## `ttytube play [VIDEOID]`

describe the command here

```
USAGE
$ ttytube play [VIDEOID]

OPTIONS
-h, --help show CLI help
```

_See code: [src/commands/play.ts](https://github.com/geowarin/ttytube/blob/v0.0.0/src/commands/play.ts)_

## `ttytube search [SEARCH]`

search for stuff on youtube

```
USAGE
$ ttytube search [SEARCH]

OPTIONS
--file=file dev: read from file
--json dump results to json
```