sources

README

Sources

1. CheatSh

cheatsh.CheatSh implements radium.Source using cheat.sh as the source of information.

Examples:

radium query "append file in go"

radium query "append file" -a language:go

radium query "open socket in java" -a nocolor

Attributes:

• nocolor - Specifying this will force cheat.sh to send non-colored snippets (appends ?T query param)
• language - Programming language (recommended to use append file in go format instead of this tag)

2. Tldr

sources.TLDR implements radium.Source using tldr.

Examples:

radium query "ls" --sources "tldr"

radium query "dir" --sources "tldr" -a platform:windows

Attributes:

• platform - Specifying this will limit the lookup scope to platform specific directories in tldr

3. Wikipedia

wikipedia.Wikipedia implements radium.Source using Wikipedia.

Examples:

radium query "ls" --sources "wiki"

radium query "hindi" --sources "wikipedia" -a language:hi

Attributes:

• language - Return results in specified language. (e.g., -a language:hi will look up in https://hi.wikipedia.org/wiki)

4. DuckDuckGo

duckduckgo.DuckDuckGo implements radium.Source using DuckDuckGo Instant Answers API.

Examples:

radium query "apple inc" --sources "ddg"

radium query "spacex" --sources "duckduckdgo" 

5. LearnXInYMinutes

sources.LearnXInY implements radium.Source using learnxinyminutes.

Examples:

radium query "dart" --sources "lxy"

Documentation

Index

• type LearnXInY
  • func NewLearnXInYMins() *LearnXInY
  • func (lxy LearnXInY) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)
• type Radium
  • func NewRadium(serverURL string) *Radium
  • func (rad Radium) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)
• type TLDR
  • func NewTLDR() *TLDR
  • func (tldr TLDR) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)

Types

type LearnXInY

type LearnXInY struct {
}

LearnXInY implements radium.Source using LearnXInY github repository

func NewLearnXInYMins

func NewLearnXInYMins() *LearnXInY

NewLearnXInYMins initializes a radium.Source implementation using LearnXInY github repository as the source of reference.

func (LearnXInY) Search

func (lxy LearnXInY) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)

Search attempts to download the appropriate markdown file from learn-x-in-y repository and format it as a result

type Radium

type Radium struct {
	// contains filtered or unexported fields
}

Radium implements radium.Source interface using radium server as the source of reference

func NewRadium

func NewRadium(serverURL string) *Radium

NewRadium initializes a radium.Source implementation using the given radium server url

func (Radium) Search

func (rad Radium) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)

Search makes a GET /search to the radium server and formats the response

type TLDR

type TLDR struct {
}

TLDR implements radium.Source using tldr-pages as the source of reference

func NewTLDR

func NewTLDR() *TLDR

NewTLDR initializes a radium.Source implementation using the popular tldr-pages as a source

func (TLDR) Search

func (tldr TLDR) Search(ctx context.Context, query radium.Query) ([]radium.Article, error)

Search for a particular query in tldr-pages repository