commands

Documentation

Index

• Variables

Variables

var Fetch = &cli.Command{
	Name:  "fetch",
	Usage: "Fetches OCI data from a regitry",

	Subcommands: []*cli.Command{
		{
			Name:      "image",
			Usage:     "fetches an image's metadata - assumes ref points to a manifest",
			ArgsUsage: "<ref>",
			Action:    actionFetchImageMD,
			Flags: []cli.Flag{
				&cli.StringFlag{
					Name:  "platform",
					Usage: "select a particular platform",
				},
			},
		},
		{
			Name:      "manifest",
			Usage:     "fetches an image manifest",
			ArgsUsage: "<ref>",
			Action:    actionFetchManifest,
			Flags: []cli.Flag{
				&cli.StringFlag{
					Name:  "platform",
					Usage: "select a particular platform",
				},
			},
		},
		{
			Name:      "raw",
			Usage:     "fetches data directly without trying to interpret it",
			ArgsUsage: "<ref>",
			Action:    actionFetchDirect,
		},
		{
			Name:      "layer",
			Usage:     "downloads a layer blob",
			ArgsUsage: "<ref>",
			Flags: []cli.Flag{
				&cli.StringFlag{
					Name:     "position",
					Aliases:  []string{"p"},
					Usage:    `Either "first", "last", a positive number indexing layers starting from the first or a negative number indexing layers starting from the last`,
					Required: true,
				},
				&cli.StringFlag{
					Name:        "output",
					Aliases:     []string{"o"},
					TakesFile:   true,
					DefaultText: "<layer-hash>.tar.gz",
					Usage:       "output path",
				},
				&cli.StringFlag{
					Name:  "platform",
					Usage: "select a particular platform",
				},
				&cli.BoolFlag{
					Name:    "quiet",
					Aliases: []string{"q"},
				},
			},
			Action: actionFetchLayer,
		},
		{
			Name:      "file",
			Usage:     "downloads a file from a layer blob",
			ArgsUsage: "<ref> <path>",
			Flags: []cli.Flag{
				&cli.StringFlag{
					Name:        "output",
					Aliases:     []string{"o"},
					TakesFile:   true,
					DefaultText: "<basename(path)>",
					Usage:       "output path",
				},
				&cli.StringFlag{
					Name:  "platform",
					Usage: "select a particular platform",
				},
				&cli.BoolFlag{
					Name:    "quiet",
					Aliases: []string{"q"},
				},
			},
			Action: actionFetchFile,
		},
	},
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:  "digest",
			Usage: "digest of the object to fetch",
		},
		&cli.StringFlag{
			Name:  "media-type",
			Usage: "media-type of the object to fetch",
		},
		&cli.BoolFlag{
			Name:  "descriptor-from-stdin",
			Usage: "parses the OCI descriptor of the object to fetch from STDIN. --digest and --media-type override values parsed from STDIN.",
		},
		&cli.BoolFlag{
			Name:  "insecure",
			Usage: "fetch via HTTP rather than HTTPS",
		},
	},
}

var Layer = &cli.Command{
	Name:  "layer",
	Usage: "provides information about an image's layers - assumes ref and digest point to a manifest",
	Subcommands: []*cli.Command{
		{
			Name:      "list",
			Usage:     "lists the layer digests",
			ArgsUsage: "<ref>",
			Flags: []cli.Flag{
				&cli.BoolFlag{
					Name:  "unpacked",
					Usage: "list digests of the unpacked layer (from the image config)",
				},
			},
			Action: actionListLayer,
		},
		{
			Name:      "size",
			Usage:     "prints the total bytes of all downloaded layers",
			ArgsUsage: "<ref>",
			Action:    actionSizeLayer,
		},
	},
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:  "digest",
			Usage: "digest of the object where to start from",
		},
		&cli.StringFlag{
			Name:  "platform",
			Usage: "select a particular platform",
		},
	},
}

var Resolve = &cli.Command{
	Name:  "resolve",
	Usage: "resolves a reference",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:  "familiar",
			Value: true,
			Usage: "interpret reference as familiar Docker reference, e.g. alpine:latest as docker.io/library/alpine:latest",
		},
	},
	Subcommands: []*cli.Command{
		{
			Name:      "name",
			Usage:     "resolves a reference to its digested name",
			ArgsUsage: "<ref>",
			Action:    actionResolve(false, "name"),
		},
		{
			Name:      "descriptor",
			Aliases:   []string{"desc"},
			Usage:     "resolves a reference to its descriptor",
			ArgsUsage: "<ref>",
			Action:    actionResolve(true, "descriptor"),
		},
	},
}