Table of Contents

1. About
2. Features
3. Installation
   1. Pip under user
4. Usage
   1. Basic Commands
   2. Configuration and extension
      1. Configuration File Format
      2. Custom Actions
5. License
   1. Code

XMach - X(.O) (make) mach(inery).

Cross-platform task runner with current implementation in Python.

About

XMach is a minimalist, cross-platform task runner that allows to define and execute custom actions through a plugin-like system.

It provides a command-line interface for running tasks, managing configuration, and extending functionality through Python scripts.

Features

• cross-platform task execution
• extensible action system through python scripts
• built-in actions (ie for listing tasks and configuration management)
• environment variable support
• parallel job execution support
• plugin-like architecture with `xmach.d` directory

Installation

Pip under user

pip install --break-system-packages --user xmach-app

Usage

Basic Commands

# List available actions
xmach list

# Write default configuration file
xmach write-default-config

# Run custom actions
xmach my-action arg1 arg2

# Run multiple actions
xmach action1,action2 arg1 arg2

# Run with multiple jobs
xmach my-action --jobs 4

Configuration and extension

XMach looks for configuration in the `xmach.d` directory:

• xmach-config.json - main configuration file
• xmach-config.example.json - example configuration template
• xmach_*.py - python files containing custom action definitions

Configuration File Format

{
  "environment": {
    "CUSTOM_VAR": "value"
  },
  "scons_args": {
    "parameter": "value"
  }
}

Custom Actions

Create Python files in the xmach.d directory with names like xmach_myactions.py:

#!/usr/bin/env python

class ActionScripts(ActionScriptsBase):
    def action__my_custom_action(self, action_args: list[str] = []) -> None:
        """Action: my-custom-action"""

        # Run shell commands
        RunCmd.run_cmd(cmd=["echo", "Hello World"])

License

Code

Code in this project is licensed under the MPL, version 2.0.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.