Scroll to navigation

ITAMAE(1) Itamae Manual ITAMAE(1)

NAME

itamae - Simple and lightweight configuration management tool inspired by Chef.

SYNOPSIS

itamae destroy [cookbook|role] [NAME]

itamae docker RECIPE [RECIPE...]

itamae generate [cookbook|role] [NAME]

itamae help [COMMAND]

itamae init NAME

itamae jail RECIPE [RECIPE...]

itamae local RECIPE [RECIPE...]

itamae ssh RECIPE [RECIPE...]

itamae tree

itamae version

DESCRIPTION

itamae(1) is a simple and lightweight configuration management tool inspired by Chef. It prints its version as Itamae v1.16.0.

SUBCOMMANDS

destroy

Undo role or cookbook (short-cut alias d).

docker

Create Docker image.

generate

Initialize role or cookbook (short-cut alias g).

help

Describe available commands or one specific command.

init

Create a new project.

jail

Run Itamae in a jail.

local

Run Itamae locally.

ssh

Run Itamae via ssh.

tree

Print a tree of all available commands.

version

Print version.

OPTIONS

Boolean options also accept a --no- form and a --skip- form.

The following options apply to docker, jail, local, and ssh.

--recipe-graph=PATH

[EXPERIMENTAL] Write recipe dependency graph in DOT.

-j, --node-json=NODE_JSON

Load node data from a JSON file. This option may be given more than once.

-y, --node-yaml=NODE_YAML

Load node data from a YAML file. This option may be given more than once.

-n, --[no-]dry-run

Only show the steps that would be taken. Default disabled.

--shell=SHELL

Shell to use. Default /bin/sh.

--[no-]login-shell

Use a login shell. Default disabled.

--[no-]ohai

This option is DEPRECATED and will be unavailable. Default disabled.

--profile=PATH

[EXPERIMENTAL] Save profiling data.

--[no-]detailed-exitcode

Enable detailed exit codes (default disabled). See EXIT STATUS.

-l, --log-level=LOG_LEVEL

Set the level of logging detail. Default info. Possible values, from least verbose to most verbose, are unknown, fatal, error, warn, info, and debug.

--[no-]color

Enable color logging. Default enabled.

-c, --config=CONFIG

Load configuration from a YAML file.

-t, --tmp-dir=TMP_DIR

Temporary directory. Default /tmp/itamae_tmp.

docker

--image=IMAGE

Output image. This option or the --container option is required.

--container=CONTAINER

Output container. This option or the --image option is required.

--[no-]tls-verify-peer

Verify TLS certificates. Default enabled.

--tag=TAG

Tag name of the created Docker image.

jail

--jail-name=JAIL_NAME

Jail hostname.

ssh

-h, --host=HOST

Connect to HOST. This option or --vagrant must be specified.

-u, --user=USER

Connect as USER.

-i, --key=KEY

Connect using the private key KEY.

-p, --port=PORT

Connect to PORT.

--ssh-config=SSH_CONFIG

Use SSH_CONFIG.

--[no-]vagrant

Use Vagrant. Default disabled. This option or --host must be specified.

--[no-]ask-password

Prompt for a password. Default disabled.

--[no-]ask-passphrase

Prompt for an SSH key passphrase. Default disabled.

--[no-]sudo

Use sudo on the remote host. Default enabled.

ENVIRONMENT

SUDO_PASSWORD

Password used when a command needs elevated privileges. If it is unset, Itamae prompts for the password.

EXIT STATUS

With --detailed-exitcode disabled (the default):

0

The run succeeded. Some resources may have changed.

1

The run failed.

With --detailed-exitcode enabled:

0

The run succeeded with no changes or failures.

1

The run failed.

2

The run succeeded, and some resources were changed.

EXAMPLES

Print the version:

itamae version

Show the options for a local run:

itamae help local

Run a recipe on the local machine:

itamae local recipe.rb

BUGS

Refer to the Itamae issue tracker at <https://github.com/itamae-kitchen/itamae/issues>

AUTHORS

Itamae was written by Ryota Arai, and other contributors.

This man page was written by Scott Leggett for the Debian Project, and updated by Simon Quigley.

RESOURCES

Project web site: <https://itamae.kitchen/>

Git source repository on GitHub: <https://github.com/itamae-kitchen/itamae>

GitHub organization: <https://github.com/itamae-kitchen>

COPYING

Copyright (C) 2013-2015 Ryota Arai. Free use of this software is granted under the terms of the MIT License.

AUTHOR

Ryota Arai

November 2026 Itamae 1.16.0