S Technologies's Logo

Color

Green
Teal
Indigo
Blue
Purple
Red
Rose

Mode

Light

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, the project scope wins. If no config exists, Shemul suggests running shemul init -g.

Initializing a config

  • shemul init [template] creates a project shemul.json. Without a template it uses none.
  • shemul init -g [template] creates the global shemul.json. Without a template it uses none.
  • If a config already exists, init warns with its path and opens the file for editing.
  • Use --force to 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.