enma

Yet another integration software with file monitoring.

enma is a file-watching tool that monitors specified files or directories and automatically executes commands or rebuilds and restarts daemons.
It's designed to supercharge your development and automation workflows.

✨ Features

• 📂 Realtime monitoring for directories or files
• 🛠️ Execute build or custom commands on file changes
• 🔁 Hot-reload support with build success detection
• 🔗 Supports symlinks
• 🧩 Flexible configuration using TOML files
• 🔍 Ignore patterns with .enmaignore (.gitignore compatible syntax)
• 🧪 Ideal for CI/CD and local development

---

🚀 Quick Start

1. Installation

go install github.com/magicdrive/enma@latest

Alternatively, you can download a pre-built binary from the Releases page.

2. Initialize project

enma init

This generates Enma.toml and .enmaignore.

You can specify the mode or config file name:

enma init --mode watch --file ./myconfig.enma.toml

---

🔥 Hotload Mode

Use this when you want to automate build and daemon restarts.

Example Config (Enma.toml)

name = "my-app"
daemon = "./my-app"
build = "go build -o my-app main.go"
watch-dir = ["./cmd", "./internal"]

Run

enma hotload --daemon ./my-app --build "go build -o my-app main.go" --watch-dir ./cmd,./internal

---

👀 Watch Mode

Executes commands on file changes without restarting daemons.

Example Config (Enma.toml)

command = "make test"
watch-dir = ["./pkg", "./lib"]

Run

enma watch --command "make test" --watch-dir ./pkg,./lib

---

🔍 File Filtering Order

When monitoring file changes, Enma filters target files based on the following order:

1. If the file does not match --pattern-regex, it is excluded.
2. If the file matches --exclude-dir or --exclude-ext, it is excluded.
3. If the file matches --ignore-dir-regex or --ignore-file-regex, it is excluded.
4. If the file is listed in the .enmaignore file, it is excluded.
5. If --include-ext is specified and the file does not match any of the extensions, it is excluded.
6. Files that pass all the above filters are considered as watch targets.

💡 Why This Order Makes Sense

This filtering order is designed to be both efficient and intuitive:

• Early exclusion improves performance by skipping unnecessary processing for files that obviously shouldn't be watched.
• --pattern-regex acts as a top-level filter, giving users full control over what files are even considered.
• --exclude-* and --ignore-* rules eliminate unwanted files using both simple and flexible patterns.
• The .enmaignore file gives users a familiar, Git-style way to exclude files explicitly.
• Finally, --include-ext allows users to narrow down the remaining files by extension, but only if they choose to use it.

This layered approach ensures clarity in behavior while keeping Enma fast and customizable.

---

🧾 Full Command Reference

Global Options

Option	Description
-h, --help	Show help message and exit
-v, --version	Show version
-c, --config	Specify config file. Default: ./Enma.toml, ./.enma.toml, or ./.enma/enma.toml

---

enma init

Option	Description
-h, --help	Show help message and exit
-m, --mode	Mode for config file: hotload or watch (default: hotload)
-f, --file <filename>	Config filename to create (default: ./Enma.toml)

---

enma hotload

Option	Description
-h, --help	Show help message and exit
-d, --daemon <command>	Daemon command to run (required)
-b, --build <command>	Command to build the daemon (required)
-w, --watch-dir <dir_name>	Watch directories (comma-separated, required)
-p, --pre-build <command>	Command to run before build (optional)
-P, --post-build <command>	Command to run after build (optional)
-W, --working-dir <dir_name>	Working directory (default: $PWD)
-I, --placeholder	Placeholder in command for changed file (default: {})
-A, --abs, --absolute-path	Use absolute path in placeholder (optional)
-t, --timeout <time>	Timeout for build command (default: 5sec)
-l, --delay <time>	Delay after build command (default: 0sec)
-r, --retry <number>	Retry count (default: 0)
-x, --pattern-regex <regex>	Regex pattern to watch (optional)
-i, --include-ext <ext>	File extensions to include (comma-separated, optional)
-g, --ignore-dir-regex <regex>	Regex to ignore directories (optional)
-G, --ignore-file-regex <regex>	Regex to ignore files (optional)
-e, --exclude-ext <ext>	File extensions to exclude (comma-separated, optional)
-E, --exclude-dir <dir_name>	Directories to exclude (comma-separated, optional)
-n, --enmaignore <filename>	enma ignore file(s) (comma-separated, optional. default: ./.enmaignore)
--logs <log_file_path>	Log file path (optional)
--pid <pid_file_path>	PID file path (optional)

---

enma watch

Option	Description
-h, --help	Show help message and exit
-c, --command, --cmd <command>	Command to run on file change (required)
-w, --watch-dir <dir_name>	Watch directories (comma-separated, required)
-p, --pre-cmd <command>	Command to run before main command (optional)
-P, --post-cmd <command>	Command to run after main command (optional)
-W, --working-dir <dir_name>	Working directory (default: $PWD)
-I, --placeholder	Placeholder in command for changed file (default: {})
-A, --abs, --absolute-path	Use absolute path in placeholder (optional)
-t, --timeout <time>	Timeout for command (default: 5sec)
-l, --delay <time>	Delay after command (default: 0sec)
-r, --retry <number>	Retry count (default: 0)
-x, --pattern-regex <regex>	Regex pattern to watch (optional)
-i, --include-ext <ext>	File extensions to include (comma-separated, optional)
-g, --ignore-dir-regex <regex>	Regex to ignore directories (optional)
-G, --ignore-file-regex <regex>	Regex to ignore files (optional)
-e, --exclude-ext <ext>	File extensions to exclude (comma-separated, optional)
-E, --exclude-dir <dir_name>	Directories to exclude (comma-separated, optional)
-n, --enmaignore <filename>	enma ignore file(s) (comma-separated, optional. default: ./.enmaignore)
--logs <log_file_path>	Log file path (optional)
--pid <pid_file_path>	PID file path (optional)

---

🗂 Example .enmaignore

The syntax of .enmaignore is a compatible syntax of .gitignore.

# =============================
# VCS / Version Control
# =============================
.git/
.hg/
.svn/

# =============================
# Editors / IDEs
# =============================
.idea/
.vscode/
*.code-workspace
*.sublime-project
*.sublime-workspace

---

Author

Copyright (c) 2025 Hiroshi IKEGAMI

---

License

This project is licensed under the MIT License