ks_pkg_describe.md

ks pkg describe

Describe a ksonnet package and its contents

Synopsis

The describe command outputs documentation for a package that is available (e.g. downloaded) in the current ksonnet application. (This must belong to an already known <registry-name> like incubator). The output includes:

1. The package name
2. A brief description provided by the package authors
3. A list of available prototypes provided by the package

Related Commands

• ks pkg list — List all packages known (downloaded or not) for the current ksonnet app
• ks prototype describe — See more info about a prototype's output and usage
• ks generate — Use the specified prototype to generate a component manifest

Syntax

ks pkg describe [<registry-name>/]<package-name> [flags]

Options

  -h, --help   help for describe

Options inherited from parent commands

      --dir string        Ksonnet application root to use; Defaults to CWD
      --tls-skip-verify   Skip verification of TLS server certificates
  -v, --verbose count     Increase verbosity. May be given multiple times.

SEE ALSO

• ks pkg - Manage packages and dependencies for the current ksonnet application