local

README

Local

This package contains utility functions that provide access to local assets (such as a local git repository) to display on the CLI and creates config files for Inertia upon first-time setup.

Documentation

Overview

Package local provides access to local assets for the CLI

Index

• Constants
• func GetClient(name, relPath string, cmd ...*cobra.Command) (*client.Client, func() error, error)
• func GetProjectConfigFromDisk(relPath string) (*cfg.Config, string, error)
• func GetRepoCurrentBranch() (string, error)
• func GetRepoRemote(remote string) (string, error)
• func InitializeInertiaProject(configPath, version, buildType, buildFilePath string) error
• func SaveKey(keyMaterial string, path string) error

Constants

const (
	// EnvSSHPassphrase is the key used to fetch PEM key passphrases
	EnvSSHPassphrase = "PEM_PASSPHRASE"
)

Functions

func GetClient

func GetClient(name, relPath string, cmd ...*cobra.Command) (*client.Client, func() error, error)

GetClient returns a local deployment setup

func GetProjectConfigFromDisk

func GetProjectConfigFromDisk(relPath string) (*cfg.Config, string, error)

GetProjectConfigFromDisk returns the current project's configuration. If an .inertia folder is not found, it returns an error.

func GetRepoCurrentBranch

func GetRepoCurrentBranch() (string, error)

GetRepoCurrentBranch returns the current repository branch

func GetRepoRemote

func GetRepoRemote(remote string) (string, error)

GetRepoRemote reads a remote URL

func InitializeInertiaProject

func InitializeInertiaProject(configPath, version, buildType, buildFilePath string) error

InitializeInertiaProject creates the inertia config folder and returns an error if we're not in a git project.

func SaveKey

func SaveKey(keyMaterial string, path string) error

SaveKey writes a key to given path