bits

Documentation

Index

• Variables
• func Describe(ctx context.Context, dir string) (desc *app.Desc, err error)
• func Extract(ctx context.Context, b *Bit, dst string) error
• type Bit
  • func Get(ctx context.Context, slug string) (*Bit, error)
  • func List(ctx context.Context) ([]*Bit, error)

Variables

var ErrNotFound = errors.New("bit not found")

ErrNotFound is reported by Get if the bit with the given slug is not found.

Functions

func Describe

func Describe(ctx context.Context, dir string) (desc *app.Desc, err error)

Describe describes the contents of the bit extracted in dir.

func Extract

func Extract(ctx context.Context, b *Bit, dst string) error

Extract downloads and extracts a bit into a given directory.

Types

type Bit

type Bit struct {
	Slug        string
	Title       string
	Description string

	// GitHubTree is a URL to the GitHub tree for this bit,
	// in the format expected by github.ParseTree.
	GitHubTree string
}

func Get

func Get(ctx context.Context, slug string) (*Bit, error)

Get retrieves a bit by its slug.

func List

func List(ctx context.Context) ([]*Bit, error)

List lists available bits.