eletrize

README

⚡ Eletrize

Eletrize is a live reload tool for Go and other languages. It watches for file changes in your project and automatically runs commands, speeding up development and testing workflows.

📖 English | Português

---

🚀 Installation

Requirements:

• Go 1.23 or later

To install Eletrize, run:

go install github.com/lasfh/eletrize@latest

---

⚙️ Basic Usage

Run a simple command with file watching:

eletrize run ./server "go build" --ext=.go --label="API" --env=.env

This command:

• Watches the directory for changes in .go files.
• Runs go build and .server when changes are detected.
• Loads environment variables from the .env file.

---

📁 Configuration Files

Eletrize can automatically detect configuration files named:

• eletrize.yml
• eletrize.yaml
• .eletrize.yml
• .eletrize.yaml
• eletrize.json
• .eletrize.json
• .eletrize (JSON format)

To run Eletrize with a config file:

eletrize

Or specify the path manually:

eletrize path/eletrize.yml

---

🧪 Running a Specific Schema

If your config file contains multiple schemas, you can specify one using:

eletrize eletrize.yml --schema=1

Replace 1 with the desired schema index.

---

📝 Configuration Example

schema:
  - label: API
    workdir: ""
    envs:
      key: "value"
    env_file: ".env"
    watcher:
      path: "."
      recursive: true
      excluded_paths:
        - "frontend"
      extensions:
        - ".go"
    commands:
      build:
        method: "go"
        args:
          - "build"
        envs:
          key: "value"
        env_file: ""
      run:
        - method: "./server"
          envs:
            PORT: "8080"
          env_file: ""

---

🔧 VSCode Launch Configuration

Eletrize can automatically detect and use VSCode launch configurations from .vscode/launch.json. This feature allows you to leverage your existing VSCode debug configurations for live reloading.

To use VSCode launch detection:

eletrize

Eletrize will automatically detect:

• Go launch configurations with "type": "go", "request": "launch", and "mode": "auto"
• Program path (supports ${workspaceFolder} variable)
• Environment variables and environment files
• Command line arguments

Example .vscode/launch.json:

{
    "configurations": [
        {
            "name": "Launch Server",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceFolder}/cmd/server",
            "args": ["--port", "8080"],
            "envFile": "${workspaceFolder}/.env",
            "env": {
                "DEBUG": "true"
            }
        }
    ]
}

This configuration will be automatically converted to watch .go files and run the server with live reloading.

---

🧰 Additional Features

• Multi-directory watching: Define multiple schemas to monitor different parts of your project.
• Language-agnostic support: While optimized for Go, Eletrize can be configured for other languages.
• Advanced customization: Combine extensions, commands, and environment variables to tailor Eletrize to your project.
• VSCode integration: Automatically detect and use VSCode launch configurations for seamless development workflow.

---

📄 License

This project is licensed under the MIT License.

---