You are reading the documentation for v1.x, an older version.Read the latest (v2.x) →
Configuration
Shemul supports two config scopes:
- Project scope:
<project>/shemul.json - Global scope (Windows):
%APPDATA%\Shemul\shemul.json - Global scope (macOS):
~/Library/Application Support/Shemul/shemul.json - Global scope (Linux):
$XDG_CONFIG_HOME/shemul/shemul.json, falling back to~/.config/shemul/shemul.json
If both scopes define the same command, project scope wins. If no config exists, Shemul suggests running shemul init -g.
Initializing a config
shemul init [template]creates a projectshemul.json. Without a template it usesnone.shemul init -g [template]creates the globalshemul.json. Without a template it usesnone.- If a config already exists,
initwarns with its path and opens the file for editing. - Use
--forceto overwrite an existing config.
Available templates: docker-fastapi-backend, fastapi-backend, django-drf-backend, expressjs-backend, nestjs-backend, react-native-expo-app, nextjs-frontend and none. Run shemul init --list to list them.