Scroll to navigation

KNIFE-DIFF(1) knife diff KNIFE-DIFF(1)


knife-diff - The man page for the knife diff subcommand.
The knife diff subcommand is used to compare the differences between files and directories on the server and in the chef-repo. For example, to compare files on the server prior to an uploading or downloading files using the knife download and knife upload subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the git diff command that can be used to diff what is in the chef-repo with what is synced to a git repository.
This argument has the following syntax:
$ knife diff [PATTERN...] (options)
This subcommand has the following options:
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.
Indicates whether colored output will be used.
--cookbook-version VERSION
The version of a cookbook to be downloaded.
The number of allowed concurrent connections. Default: 10.
-d, --disable-editing
Indicates that $EDITOR will not be opened; data will be accepted as-is.
Indicates that Knife will use the default value, instead of asking a user to provide one.
Indicates that files will be selected that have been added (A), deleted ( D), modified (M), and/or have had their type changed ( T). Any combination of filter characters may be used, including no filter characters. Use * to select all paths if a file matches other criteria in the comparison. Default value: nil.
-e EDITOR, --editor EDITOR
The $EDITOR that is used for all interactive commands.
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.
-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.
Indicates that only the names of modified files will be shown.
Indicates that only the names of files with a status of Added, Deleted, Modified, or Type Changed will be shown.
Use --no-recurse to disable listing a directory recursively. Default: --recurse.
Indicates that data will be shown after a destructive operation.
--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.

knife.rb File Settings
In addition to the default settings in a knife.rb file, there are other subcommand-specific settings that can be added. When a subcommand is run, Knife will use:
A value passed via the command-line
A value contained in the knife.rb file
The default value

A value passed via the command line will override a value in the knife.rb file; a value in a knife.rb file will override a default value.
The following knife diff settings can be added to the knife.rb file:
Use to add the --chef-repo-path option.
Use to add the --concurrency option.
Use to add the --name-only option.
Use to add the --name-status option.
Use to add the --recurse option.
Use to add the --repo-mode option.

To compare the "base.json" role to a "webserver.json" role, enter:
$ knife diff roles/base.json roles/webserver.json
To compare the differences between the local chef-repo and the files that are on the server, enter:
$ knife diff
To diff a node named node-lb and then only return files that have been added, deleted, modified, or changed, enter:
$ knife diff --name-status node-lb
to return something like:


Chef 11.10.0