cmd

Documentation

Index

• func Build(dir string, attribute string) error
• func CleanNameFromGraph(s string) string
• func Develop() error
• func GetDrvPathFromResult(output string, symlink string) (string, error)
• func GetNarHashFromPath(path string) (string, error)
• func Lock() error
• func ManageStdErr(stderr io.ReadCloser) error
• func ManageStdOutput(stdout io.ReadCloser) error
• func NixShowConfig() (map[string]string, error)
• func NixVersion() (string, error)
• func Run() error
• type App
  • func GetAppDetails(output string, symlink string) (*App, error)
  • func GetRuntimeClosureGraph(appName, output string, symlink string) (*App, *gographviz.Graph, error)

Functions

func Build

func Build(dir string, attribute string) error

Build invokes nix build to build the project

func CleanNameFromGraph

func CleanNameFromGraph(s string) string

CleanNameFromGraph removes leading and trailing double quotes and escape characters

func Develop

func Develop() error

Develop opens a BSF development shell

func GetDrvPathFromResult

func GetDrvPathFromResult(output string, symlink string) (string, error)

GetDrvPathFromResult returns the derivation

func GetNarHashFromPath

func GetNarHashFromPath(path string) (string, error)

GetNarHashFromPath returns the sha256 hash of the nar

func Lock

func Lock() error

Lock generates the Nix flake lock file

func ManageStdErr

func ManageStdErr(stderr io.ReadCloser) error

func ManageStdOutput

func ManageStdOutput(stdout io.ReadCloser) error

func NixShowConfig

func NixShowConfig() (map[string]string, error)

NixShowConfig returns a map of nix configuration values

func NixVersion

func NixVersion() (string, error)

NixVersion returns the current nix version

func Run

func Run() error

Run runs the project after building it based on instructions defined in bsf.hcl.

Types

type App

type App struct {
	Name         string
	Version      string
	AppType      sbom.Purpose
	ResultHash   string
	ResultDigest string
	BinaryHash   string
}

App represents the application

func GetAppDetails

func GetAppDetails(output string, symlink string) (*App, error)

GetAppDetails checks if the symlink exists

func GetRuntimeClosureGraph

func GetRuntimeClosureGraph(appName, output string, symlink string) (*App, *gographviz.Graph, error)

GetRuntimeClosureGraph returns the runtime closure graph for the project TODO: we should look into adding metadata about licenses, homepage into the graph