Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


Tool to simplify the creation of a new salt extension.

The why

salt-extension is a Python-based CLI tool for generating a project scaffolding to easily extend salt with exec modules, state modules, and more.

Extensions make life easier in several ways:

  • Deployments where proprietary Python modules are developed internally, like at enterprises that want to extend salt functionality without modifying salt itself, can follow a standard.
  • Extensions can develop and release at a faster speed than salt itself. No need to wait for a specific major release.
  • Developing extensions as separate repos allows for smaller, more isolated test suites that are tailored specifically to the scope of the extension.

This approach to development, of the salt ecosystem, could also assist in the powers of Tiamat (resources: SEP26 // tiamat-pip source code).

Converting existing module sets into extensions could begin treating salt as a more "pluggable"/"extensible" ecosystem, and could make it easier to understand what modules haven’t been contributed to in a long time. It is difficult to maintain so many modules within salt that manage and orchestrate an ocean of APIs, operating systems, clouds, etc.


The best way to use this project is with pipx:

$ pipx install salt-extension
$ mkdir my_extension
$ cd my_extension
$ create-salt-extension my_extension -l states -l module
Author: John Example Doe
Author email:
Summary: An example Salt Extension Module
License (apache, other): apache

Then follow the other output instructions.

If all goes well, you should be able to run:

$ salt-call --local my_extension.example_function text="it worked!"
    it worked!

Happy hacking!