workdir

Documentation

Index

• Constants
• Variables
• func Init(fs fsh.FS, dir string) error
• type Workdir
  • func New(ctx context.Context, fs fsh.FS, dir string) (*Workdir, error)
  • func (c *Workdir) Add(ctx context.Context, runtime, program string, alias optional.Val[string], ...) (bool, string, error)
  • func (c *Workdir) AddInclude(ctx context.Context, source string, tags []string) (int, error)
  • func (c *Workdir) CopySource(ctx context.Context, source string, tags []string) (int, error)
  • func (c *Workdir) FindTool(name string) (*structs.ToolState, error)
  • func (c *Workdir) GetTools(ctx context.Context) ([]structs.ToolState, error)
  • func (c *Workdir) RemoveTool(ctx context.Context, target string) error
  • func (c *Workdir) RunTool(ctx context.Context, str string, args ...string) error
  • func (c *Workdir) RuntimeAdd(ctx context.Context, runtime string) error
  • func (c *Workdir) RuntimeList() []string
  • func (c *Workdir) Save() error
  • func (c *Workdir) Sync(ctx context.Context, maxWorkers int, tags []string) error
  • func (c *Workdir) Upgrade(ctx context.Context, tags []string) error

Constants

const (
	StatsVer1 = "v1"
)

Variables

var (
	ErrToolNotFoundInSpec = errors.New("tool not found in spec")
	ErrToolNotInstalled   = errors.New("tool not installed")
)

Functions

func Init

func Init(fs fsh.FS, dir string) error

Init will initialize context in specified directory.

Types

type Workdir

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

func New

func New(ctx context.Context, fs fsh.FS, dir string) (*Workdir, error)

func (*Workdir) Add

func (c *Workdir) Add(ctx context.Context, runtime, program string, alias optional.Val[string], tags []string) (bool, string, error)

func (*Workdir) AddInclude

func (c *Workdir) AddInclude(ctx context.Context, source string, tags []string) (int, error)

func (*Workdir) CopySource

func (c *Workdir) CopySource(ctx context.Context, source string, tags []string) (int, error)

CopySource will add all tools from source. Source can be a path to file or a http url or git repo.

func (*Workdir) FindTool

func (c *Workdir) FindTool(name string) (*structs.ToolState, error)

func (*Workdir) GetTools

func (c *Workdir) GetTools(ctx context.Context) ([]structs.ToolState, error)

func (*Workdir) RemoveTool

func (c *Workdir) RemoveTool(ctx context.Context, target string) error

func (*Workdir) RunTool

func (c *Workdir) RunTool(ctx context.Context, str string, args ...string) error

RunTool will run a tool by its name and args.

func (*Workdir) RuntimeAdd

func (c *Workdir) RuntimeAdd(ctx context.Context, runtime string) error

func (*Workdir) RuntimeList

func (c *Workdir) RuntimeList() []string

func (*Workdir) Save

func (c *Workdir) Save() error

func (*Workdir) Sync

func (c *Workdir) Sync(ctx context.Context, maxWorkers int, tags []string) error

Sync will read the locked tools and try to install the desired version. It will skip the installation in case when we have a desired version.

func (*Workdir) Upgrade

func (c *Workdir) Upgrade(ctx context.Context, tags []string) error

Upgrade will upgrade only spec tools. and re-fetch latest versions of includes.