NAME¶

knife-upload - The man page for the knife upload subcommand.

The knife upload subcommand is used to upload roles, cookbooks, environments, and data bags to the server from the current working directory in the chef-repo. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be uploaded, and then knife download, which does the opposite of knife upload.

Syntax

This argument has the following syntax:

$ knife upload [PATTERN...] (options)

Options

This subcommand has the following options:

-c CONFIG_FILE, --config CONFIG_FILE: The configuration file to use.

--chef-repo-path PATH: The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb.

--chef-zero-port PORT: The port on which chef-zero will listen.

--[no-]color: Indicates whether colored output will be used.

--concurrency: The number of allowed concurrent connections. Default: 10.

-d, --disable-editing: Indicates that $EDITOR will not be opened; data will be accepted as-is.

--defaults: Indicates that Knife will use the default value, instead of asking a user to provide one.

--[no-]diff: Indicates that only new and modified files will be uploaded. Set to false to upload all files. Default: true.

-e EDITOR, --editor EDITOR: The $EDITOR that is used for all interactive commands.

-E ENVIRONMENT, --environment ENVIRONMENT: The name of the environment. When this option is added to a command, the command will run only against the named environment.

-F FORMAT, --format FORMAT: The output format: summary (default), text, json, yaml, and pp.

--[no-]force: Use --force to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no POST or PUT is performed unless an actual change would be made). Default: --no-force.

--[no-]freeze: Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the --force option can override this setting. Default: false.

-h, --help: Shows help for the command.

-k KEY, --key KEY: The private key that Knife will use to sign requests made by the API client to the server.

-n, --dry-run: Indicates that no action is taken and that results are only printed out. Default: false.

--print-after: Indicates that data will be shown after a destructive operation.

--[no-]purge: Use --purge to delete roles, cookbooks, etc. from the server if their corresponding files do not exist in the chef-repo. By default, such objects are left alone and NOT purged. Default: --no-purge.

--[no-]recurse: Use --no-recurse to disable uploading a directory recursively. Default: --recurse.

--repo-mode MODE: The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything.

-s URL, --server-url URL: The URL for the server.

-u USER, --user USER: The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.

-v, --version: The version of the chef-client.

-V, --verbose: Set for more verbose outputs. Use -VV for maximum verbosity.

-y, --yes: Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).

-z, --local-mode: Indicates that the chef-client will be run in local mode, which allows all commands that work against the server to also work against the local chef-repo.

Examples