Settings · instamix

Every key the config files take, with its type, its default and the environment variable that wins over it.

A key is a section and a name: run.install, env.upgrade, proxy.serve.listen. In a file the section is in brackets and the name under it; imix config set run.install true writes it for you. How the files are found, and which wins, is in the manual: Settings.

This list is what imix config keys printed when the site was built.

[cat]#

cat.bareboolean, default false: Do not add a default inventory and ansible.cfg.
cat.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[container]#

container.imagetext: The image to run ansible in (default: the script’s; see image).
container.enginepodman|docker: What runs the container (default: podman, else docker).
container.pullmissing|always|never|newer, default missing: When to pull the image.
container.dirdirectory: Build in this directory instead of a temporary one.
container.keepboolean, default false: Keep the temporary build directory.
container.installboolean, default false: Install galaxy requirements into the tree first.
container.checkboolean, default false: ansible-playbook –check.
container.diffboolean, default false: ansible-playbook –diff.
container.limittext: Limit to a host subset.
container.tagstext: Only run these tags.
container.skip-tagstext: Skip these tags.
container.becomeboolean, default false: Run operations with become.
container.usertext: Connect as this user.
container.connectiontext: Connection type.
container.extra-varstext, repeatable: Extra variables (repeatable).
container.inventorytext: Override the inventory.
container.start-at-tasktext: Start at this task.
container.vault-password-filetext: Vault password file.
container.verbosecount, default 0: Pass -v to ansible (repeatable).
container.recordfile: Also write the run’s events to FILE (JSONL), for imix replay; ansible’s output stays as it is.
container.bareboolean, default false: Do not add a default inventory and ansible.cfg.
container.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
container.outside-pathsboolean, default true: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[describe]#

describe.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[diff]#

diff.bareboolean, default false: Do not add a default inventory and ansible.cfg.
diff.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[doctor]#

doctor.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
doctor.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[env]#

env.dirdirectory: Build here instead of the cache (~/.cache/instamix/envs).
env.upgradeboolean, default false: Resolve the requirements again instead of reusing the lock.
env.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[generate]#

generate.forceboolean, default false: Write into a non-empty directory instamix did not create.
generate.compressbz2|gz|none|xz: Write a tar archive with this compression, whatever DEST is called (default: from the name; gz for -).
generate.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
generate.bareboolean, default false: Do not add a default inventory and ansible.cfg.
generate.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
generate.outside-pathsboolean, default false: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[image]#

image.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[install]#

install.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
install.skip-requirementsboolean, default false: Run even if this machine lacks the script’s runtime requirements.
install.bareboolean, default false: Do not add a default inventory and ansible.cfg.
install.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
install.outside-pathsboolean, default false: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[lint]#

lint.no-checksboolean, default false: Skip the registered checks.
lint.no-builtin-checksboolean, default false: Skip instamix’s own structural checks.
lint.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
lint.skip-requirementsboolean, default false: Run even if this machine lacks the script’s runtime requirements.
lint.bareboolean, default false: Do not add a default inventory and ansible.cfg.
lint.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
lint.outside-pathsboolean, default false: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[profiles]#

profiles.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[run]#

run.dirdirectory: Build in this directory instead of a temporary one.
run.keepboolean, default false: Keep the temporary build directory.
run.installboolean, default false: Install galaxy requirements into the tree first.
run.checkboolean, default false: ansible-playbook –check.
run.diffboolean, default false: ansible-playbook –diff.
run.limittext: Limit to a host subset.
run.tagstext: Only run these tags.
run.skip-tagstext: Skip these tags.
run.becomeboolean, default false: Run operations with become.
run.usertext: Connect as this user.
run.connectiontext: Connection type.
run.extra-varstext, repeatable: Extra variables (repeatable).
run.inventorytext: Override the inventory.
run.start-at-tasktext: Start at this task.
run.vault-password-filetext: Vault password file.
run.verbosecount, default 0: Pass -v to ansible (repeatable).
run.recordfile: Also write the run’s events to FILE (JSONL), for imix replay; ansible’s output stays as it is.
run.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
run.skip-requirementsboolean, default false: Run even if this machine lacks the script’s runtime requirements.
run.bareboolean, default false: Do not add a default inventory and ansible.cfg.
run.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
run.outside-pathsboolean, default false: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[show]#

show.bareboolean, default false: Do not add a default inventory and ansible.cfg.
show.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.

[test]#

test.dirdirectory: Build in this directory instead of a temporary one.
test.keepboolean, default false: Keep the build directory.
test.installboolean, default false: Install galaxy requirements into the tree first.
test.runnerauto|molecule|ansible-test|playbook, default auto: Force a runner instead of picking one.
test.kindsanity|units|integration, default sanity: What ansible-test should run.
test.envboolean, default false, env INSTAMIX_ENV: Run ansible from an environment built (or reused) with uv from the script’s requirements; see env.
test.skip-requirementsboolean, default false: Run even if this machine lacks the script’s runtime requirements.
test.bareboolean, default false: Do not add a default inventory and ansible.cfg.
test.profiletext, repeatable: Activate a profile (repeatable, comma-separated; ‘*’ for all). Read before the script runs, so it also steers what it declares.
test.outside-pathsboolean, default false: Let the environment’s (–env) or the image’s (container) collections and roles count: the tree’s ansible.cfg names them after its own, and –install does not install them again. Off, only the tree’s count.

[import]#

import.outputpath: Write the script here instead of stdout.

[proxy]#

proxy.dbfile, env INSTAMIX_PROXY_DB: The lists database (default: ~/.instamix/proxy.db).
proxy.cachedirectory, env INSTAMIX_PROXY_CACHE: Where files are cached (default: ~/.cache/instamix/proxy).
proxy.listtext, env INSTAMIX_PROXY_LIST: The list to work on (default: default). As the proxy.list setting, also the list scripts fetch through when they name none.
proxy.urltext, env INSTAMIX_PROXY: Fetch collections, roles and pip packages through this instamix proxy (INSTAMIX_PROXY wins).

[proxy.cache]#

proxy.cache.kindcollection|role|pip: Only this kind.

[proxy.check]#

proxy.check.listtext: The list to work on (default: default).

[proxy.clean]#

proxy.clean.older-thanfloat: Files not used for this many days.
proxy.clean.kindcollection|role|pip: Only this kind.

[proxy.create]#

proxy.create.copytext: Start with this list’s rules.
proxy.create.notetext: What the list is for.

[proxy.delete]#

proxy.delete.listtext: The list to work on (default: default).

[proxy.denials]#

proxy.denials.limitinteger, default 50: How many.
proxy.denials.listtext: The list to work on (default: default).

[proxy.edit]#

proxy.edit.listtext: The list to work on (default: default).

[proxy.flush]#

proxy.flush.listtext: The list to work on (default: default).

[proxy.insert]#

proxy.insert.atinteger: Before line N (default: after the last).
proxy.insert.listtext: The list to work on (default: default).

[proxy.load]#

proxy.load.listtext: The list to work on (default: default).

[proxy.maps]#

proxy.maps.listtext: The list to work on (default: default).

[proxy.replace]#

proxy.replace.listtext: The list to work on (default: default).

[proxy.serve]#

proxy.serve.listentext, default 127.0.0.1:8470: Where to accept connections.
proxy.serve.galaxytext, default https://galaxy.ansible.com, env INSTAMIX_PROXY_GALAXY: The Galaxy (or Automation Hub) to fetch from.
proxy.serve.pypitext, default https://pypi.org/simple, env INSTAMIX_PROXY_PYPI: The simple index to fetch from.

[proxy.show]#

proxy.show.listtext: The list to work on (default: default).

[replay]#

replay.hosttext: Only this host.

[spec]#

spec.outputfile: Write the document here instead of stdout.

[hub]#

hub.urltext: Take the hosts, and what groups and hosts set, from this inventory hub: its URL, or the path of its database (INSTAMIX_HUB wins).
hub.teamtext, default default: The team whose inventory it is (INSTAMIX_HUB_TEAM wins).

[plays]#

plays.pathtext: Directories with instamix scripts, apart from the repositories of imix repo, separated by colons.

[ansible-cfg]#

ansible-cfg.local-pathsboolean, default true: Give the tree’s ansible.cfg collections_path = ./collections and roles_path = ./roles when it sets none, so what galaxy installs stays in the tree (–env adds the environment’s after them).