env

Documentation

Overview

Package env provides subcommands for the development environment

Index

• Variables

Variables

var Cmd = &cli.Command{
	Name:    "env",
	Aliases: []string{"environment"},
	Usage:   "Facilitates development and maintenance of a Forklift environment",
	Flags: []cli.Flag{
		&cli.StringSliceFlag{
			Name:    "plt",
			Aliases: []string{"pallets"},
			Usage: "Replaces version-locked pallets from the cache with the corresponding pallets in " +
				"the specified directory paths",
		},
	},
	Subcommands: []*cli.Command{
		{
			Name:     "cache-plt",
			Aliases:  []string{"cache-pallets"},
			Category: "Use the environment",
			Usage:    "Updates the cache with the pallets available in the development environment",
			Action:   cachePltAction,
		},
		{
			Name:     "cache-img",
			Aliases:  []string{"cache-images"},
			Category: "Use the environment",
			Usage:    "Pre-downloads the Docker container images required by the development environment",
			Action:   cacheImgAction,
		},
		{
			Name:     "check",
			Category: "Use the environment",
			Usage:    "Checks whether the development environment's resource constraints are satisfied",
			Action:   checkAction,
		},
		{
			Name:     "plan",
			Category: "Use the environment",
			Usage: "Determines the changes needed to update the Docker Swarm to match the deployments " +
				"specified by the local environment",
			Action: planAction,
		},
		{
			Name:     "apply",
			Category: "Use the environment",
			Usage: "Updates the Docker Swarm to match the deployments specified by the " +
				"development environment",
			Action: applyAction,
		},
		{
			Name:     "show",
			Category: "Query the environment",
			Usage:    "Describes the development environment",
			Action:   showAction,
		},
		{
			Name:     "ls-plt",
			Aliases:  []string{"list-pallets"},
			Category: "Query the environment",
			Usage:    "Lists pallets specified by the environment",
			Action:   lsPltAction,
		},
		{
			Name:      "show-plt",
			Aliases:   []string{"show-pallet"},
			Category:  "Query the environment",
			Usage:     "Describes a pallet available in the development environment",
			ArgsUsage: "pallet_path",
			Action:    showPltAction,
		},
		{
			Name:     "ls-pkg",
			Aliases:  []string{"list-packages"},
			Category: "Query the environment",
			Usage:    "Lists packages available in the development environment",
			Action:   lsPkgAction,
		},
		{
			Name:      "show-pkg",
			Aliases:   []string{"show-package"},
			Category:  "Query the environment",
			Usage:     "Describes a package available in the development environment",
			ArgsUsage: "package_path",
			Action:    showPkgAction,
		},
		{
			Name:    "ls-depl",
			Aliases: []string{"list-deployments"},
			Usage:   "Lists package deployments specified by the development environment",
			Action:  lsDeplAction,
		},
		{
			Name:      "show-depl",
			Aliases:   []string{"show-deployment"},
			Category:  "Query the environment",
			Usage:     "Describes a package deployment specified by the development environment",
			ArgsUsage: "package_path",
			Action:    showDeplAction,
		},
		{
			Name:      "add-plt",
			Aliases:   []string{"add-pallets"},
			Category:  "Query the environment",
			Usage:     "Adds pallets to the environment, tracking specified versions or branches",
			ArgsUsage: "[pallet_path@version_query]...",
			Action:    addPltAction,
		},
	},
}