You are reading the documentation for v1.x, an older version.Read the latest (v2.x) →

The shemul.json file

shemul.json defines your commands, variables and environment presets. Here is a configuration example:

shemul.jsonjson

{
	"name": "example-project",
	"version": "1.0.0",
	"runtime": "docker",
	"env": {
		"local": {
			"compose": "docker-compose.yml"
		}
	},
	"vars": {
		"API": "api"
	},
	"commands": {
		"up": {
			"run": "docker compose up --build",
			"env": "local",
			"desc": "Start stack"
		},
		"migrate:up": {
			"run": "docker compose exec {{API}} alembic upgrade head",
			"confirm": true
		}
	}
}

Run shemul schema to print the bundled JSON Schema for the file.