table of contents
| 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
-j, --node-json=NODE_JSON
-y, --node-yaml=NODE_YAML
-n, --[no-]dry-run
--shell=SHELL
--[no-]login-shell
--[no-]ohai
--profile=PATH
--[no-]detailed-exitcode
-l, --log-level=LOG_LEVEL
--[no-]color
-c, --config=CONFIG
-t, --tmp-dir=TMP_DIR
docker¶
--image=IMAGE
--container=CONTAINER
--[no-]tls-verify-peer
--tag=TAG
jail¶
--jail-name=JAIL_NAME
ssh¶
-h, --host=HOST
-u, --user=USER
-i, --key=KEY
-p, --port=PORT
--ssh-config=SSH_CONFIG
--[no-]vagrant
--[no-]ask-password
--[no-]ask-passphrase
--[no-]sudo
ENVIRONMENT¶
SUDO_PASSWORD
EXIT STATUS¶
With --detailed-exitcode disabled (the default):
0
1
With --detailed-exitcode enabled:
0
1
2
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 |