frk

package module

v1.1.1 Latest Latest Go to latest Published: Nov 13, 2022 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/winebarrel/frk

Links

Open Source Insights

README ¶

frk

frk is summary generator for your GitHub activities. (Golang port of pepabo/furik)

Installation

brew install winebarrel/frk/frk

Usage

Usage: frk --token=STRING <command>

Flags:
  -h, --help            Show context-sensitive help.
      --version
      --token=STRING    GitHub token ($FRK_GITHUB_TOKEN)

Commands:
  activity --token=STRING
    show activity

  pulls --token=STRING
    show pull requests

Run "frk <command> --help" for more information on a command.

Documentation ¶

Index ¶

type Binds
type EventsByRepo
- func (m EventsByRepo) Itor() []*RepoEvents
type Github
- func NewGithub(token string) (*Github, error)
type PullRequestByRepo
- func (m PullRequestByRepo) Itor() []*RepoPullRequests
type RepoEvents
type RepoPullRequests

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Binds ¶

type Binds struct {
	Github *Github
}

type EventsByRepo ¶

type EventsByRepo map[string][]*github.Event

func (EventsByRepo) Itor ¶

func (m EventsByRepo) Itor() []*RepoEvents

type Github ¶

type Github struct {
	Client *github.Client
	Login  string
}

func NewGithub ¶

func NewGithub(token string) (*Github, error)

func (*Github) AllRepoNames ¶

func (gh *Github) AllRepoNames() ([]string, error)

func (*Github) EventsWithGrouping ¶

func (gh *Github) EventsWithGrouping(from time.Time, to time.Time) (EventsByRepo, error)

func (*Github) Orgs ¶

func (gh *Github) Orgs() ([]*github.Organization, error)

func (*Github) PullRequest ¶

func (gh *Github) PullRequest(fullRepoName string, state string) ([]*github.PullRequest, error)

func (*Github) PullRequests ¶

func (gh *Github) PullRequests() (PullRequestByRepo, error)

func (*Github) RepoNames ¶

func (gh *Github) RepoNames(login string) ([]string, error)

type PullRequestByRepo ¶

type PullRequestByRepo map[string][]*github.PullRequest

func (PullRequestByRepo) Itor ¶

func (m PullRequestByRepo) Itor() []*RepoPullRequests

type RepoEvents ¶

type RepoEvents struct {
	Repo   string
	Events []*github.Event
}

type RepoPullRequests ¶

type RepoPullRequests struct {
	Repo         string
	PullRequests []*github.PullRequest
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
frk command
subcmd
utils

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL