cmd

Documentation

Index

• Variables

Variables

var CmdBin = cli.Command{
	Name:  "bin",
	Usage: "download and link dependencies and build executable binary",
	Description: `Command bin downloads and links dependencies according to gopmfile,
and build executable binary to work directory

gopm bin <import path>@[<tag|commit|branch>:<value>]
gopm bin <package name>@[<tag|commit|branch>:<value>]

Can only specify one each time, and only works for projects that 
contain main package`,
	Action: runBin,
	Flags: []cli.Flag{
		cli.BoolFlag{"dir, d", "build binary to given directory(second argument)"},
		cli.BoolFlag{"update, u", "update pakcage(s) and dependencies if any"},
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}

var CmdBuild = cli.Command{
	Name:  "build",
	Usage: "link dependencies and go build",
	Description: `Command build links dependencies according to gopmfile,
and execute 'go build'

gopm build <go build commands>`,
	Action: runBuild,
	Flags: []cli.Flag{
		cli.BoolFlag{"update, u", "update pakcage(s) and dependencies if any"},
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}

var CmdConfig = cli.Command{
	Name:  "config",
	Usage: "configurate gopm global settings",
	Description: `Command config configurates gopm global settings

gopm config github [client_id] [client_secret]
`,
	Action: runConfig,
	Flags: []cli.Flag{
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}

var CmdExec = cli.Command{
	Name:  "exec",
	Usage: "execute go binary in specific version",
	Description: `Command exec builds and executes go binary in specific version 
based on the setting of your gopmfile or argument

gopm exec <import path|package name>
gopm exec <import path>@[<tag|commit|branch>:<value>]
gopm exec <package name>@[<tag|commit|branch>:<value>]

Can only specify one each time, and only works for projects that 
contain main package`,
	Action: runExec,
	Flags: []cli.Flag{
		cli.BoolFlag{"update, u", "update pakcage(s) and dependencies if any"},
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}

var CmdGen = cli.Command{
	Name:  "gen",
	Usage: "generate a gopmfile according current Go project",
	Description: `Command gen gets dependencies and generates a gopmfile

gopm gen

Make sure you run this command in the root path of a go project.`,
	Action: runGen,
	Flags: []cli.Flag{
		cli.BoolFlag{"example, e", "check dependencies for example(s)"},
		cli.BoolFlag{"verbose, v", "show process details"},
		cli.BoolFlag{"local,l", "gen local .gopmfile"},
	},
}

var CmdGet = cli.Command{
	Name:  "get",
	Usage: "fetch remote package(s) and dependencies to local repository",
	Description: `Command get fetches a package, and any pakcage that it depents on. 
If the package has a gopmfile, the fetch process will be driven by that.

gopm get
gopm get <import path>@[<tag|commit|branch>:<value>]
gopm get <package name>@[<tag|commit|branch>:<value>]

Can specify one or more: gopm get beego@tag:v0.9.0 github.com/beego/bee

If no version specified and package exists in GOPATH,
it will be skipped unless user enabled '--remote, -r' option 
then all the packages go into gopm local repository.`,
	Action: runGet,
	Flags: []cli.Flag{
		cli.BoolFlag{"gopath, g", "download all pakcages to GOPATH"},
		cli.BoolFlag{"update, u", "update pakcage(s) and dependencies if any"},
		cli.BoolFlag{"example, e", "download dependencies for example folder"},
		cli.BoolFlag{"remote, r", "download all pakcages to gopm local repository"},
		cli.BoolFlag{"verbose, v", "show process details"},
		cli.BoolFlag{"local,l", "download all packages to local gopath"},
	},
}

var CmdInstall = cli.Command{
	Name:  "install",
	Usage: "link dependencies and go install",
	Description: `Command install links dependencies according to gopmfile,
and execute 'go install'

gopm install
gopm install <import path>

If no argument is supplied, then gopmfile must be present`,
	Action: runInstall,
	Flags: []cli.Flag{
		cli.BoolFlag{"pkg, p", "only install non-main packages"},
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}

var CmdRun = cli.Command{
	Name:  "run",
	Usage: "link dependencies and go run",
	Description: `Command run links dependencies according to gopmfile,
and execute 'go run'

gopm run <go run commands>
gopm run -l  will recursively find .gopmfile with value localPath and run the cmd in the .gopmfile,windows os is unspported, you need to run the command right at the localPath dir.`,
	Action: runRun,
	Flags: []cli.Flag{
		cli.BoolFlag{"local,l", "run command with local gopath context"},
	},
}

var CmdTest = cli.Command{
	Name:  "test",
	Usage: "link dependencies and go test",
	Description: `Command test links dependencies according to gopmfile,
and execute 'go test'

gopm test <go test commands>`,
	Action: runTest,
}

var CmdUpdate = cli.Command{
	Name:  "update",
	Usage: "check and update gopm resources including itself",
	Description: `Command update checks updates of resources and gopm itself.

gopm update

Resources will be updated automatically after executed this command,
but you have to confirm before updaing gopm itself.`,
	Action: runUpdate,
	Flags: []cli.Flag{
		cli.BoolFlag{"verbose, v", "show process details"},
	},
}