suchtube

SuchTube

🔍 📼 Youtube Search as a service

SuchTube is a server and a CLI app to search videos on YouTube.

The server responds to multiple formats and even comes with Slack integration and Discord integration:

• html at GET /search.html?q=cats
• json at GET /search.json?q=cats
• text at GET /search.text?q=cats
• slack at POST /search.slack + Slack payload
• discord at POST /search.discord + Discord interaction payload

The CLI allows you to search videos without leaving the terminal:

> suchtube funny cats
> suchtube football top goals --random --open
> suchtube trending videos --duration=short
> suchtube documentary --duration=long --random
> suchtube javascript tutorials --all

Or start the server:

> suchtube --server

You can also use the search functionality as a library.

Installation and usage

Requirements

• Node.js: Currently this package officially supports (and is tested against) Node v18+.
• YouTube Data API key: Should be loaded in the current shell as an environment variable named SUCHTUBE_YOUTUBE_DATA_API_V3.

Install

Via npm:

> npm install -g suchtube
> suchtube --help

Via GitHub:

• Clone this repo and cd into it.
• Run npm install
• Run npm start to start the server
• Run bin/suchtube -h to use the CLI

The server listens by default on port 3333, if you want to change this, you can do it via the PORT environment variable. If you're starting the server using the SuchTube CLI, you can also set the port by:

> suchtube --server --port 4444

Options

Options while using the CLI are available in the following formats: --time=10 or --time 10. For the server, you should pass the options along with the query, inside the q paramater, ie: ?q=funny+cats+--time=10.

--time=10, -t=10

Starts the video at the given time in seconds.

--random, -r

Returns a random video taking into account the given topic.

--duration=short, -d=short

Filters videos by duration. Available values: any (default), short, medium, long.

--all, -a

Return all videos from the search.

--open, -o (CLI only)

Opens the video in your browser.

--full, -f (CLI only)

Displays full video's information. It corresponds to hit the /search.json endpoint against the server.

Usage as a library

You can use the SuchTube search as a library:

import { search } from 'suchtube'

search('funny cats', { random: true, duration: 'short' }).then(video => {
  console.log(video.title)
  console.log(video.link)
  console.log(video.publishedAt)
})

Slack integration

/suchtube funny cats --random

To integrate SuchTube in your Slack workspace, read the following guides: https://api.slack.com/slash-commands.

Basically, you should run the server, make it publicly available (via URL or IP) and create a custom Slash Command pointing to your instance URL.

Discord integration

/suchtube query:funny cats --random

To integrate SuchTube in your Discord server, read the following guides: https://discord.com/developers/docs/interactions/application-commands.

You need to:

• Create a Discord application at https://discord.com/developers/applications
• Set up a slash command with the name suchtube
• Add a string option named query for the search terms
• Set the interaction endpoint URL to your server instance at /search.discord
• Install the application to your Discord server

The Discord integration responds with the video link in the channel where the command was used.

Contributing

Any kind of idea, suggestion or bug report are really welcome! Just fork the repo, make your hack and send a pull request.

Thanks to all contributors, you rock 🙌

Development

Start the server in development mode (nodemon + debugging):

> npm run dev

Run tests:

> npm test

License

Copyright (c) Marc Anguera Insa. SuchTube is released under the MIT License.