cmd

Documentation

Index

• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Execute()
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error

Variables

var RootCmd = &cobra.Command{
	Use:   "vg",
	Short: "Easy and powerful workspace based development for go",
	Long: `
Virtualgo (or vg for short) is a tool which provides easy and powerful
workspace based development for Go. The vendor directory provides something
similar. However, virtualgo adds features features that are either broken or
fully missing when using a vendor directory.

Below is an example of the 'vg' command in action. For more info see detailed
command info at 'vg help <command>' or look at the README on Github:
https://github.com/GetStream/vg/blob/master/README.md

To start using virtualgo for a project run the following:

	$ cd $GOPATH/src/github.com/Getstream/example
	$ vg init  # initial creation of workspace

Now all commands will be executed from within the example workspace

	(example) $ go get github.com/pkg/errors # package only present in workspace
	(example) $ vg ensure  # installs the dependencies of the example project using dep
	(example) $ vg deactivate

If you cd back into the project the workspace is now activated automatically

	$ cd ~
	$ cd $GOPATH/src/github.com/Getstream/example
	(example) $ 

See the README on Github for more info
`,
}

RootCmd represents the base command when called without any subcommands

var (
	// Version is the version of vg, this is changed by the Makefile
	// automatically. So don't change it manually.
	Version string = "0.7.2"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Execute

func Execute()

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively