Skip to content
Ulrond edited this page Oct 24, 2024 · 4 revisions

XTS: Command Runner with YAML Configuration

xts_core simplifies the execution and management of commands across your system through a YAML-based configuration. It provides a clear and organized way to define, organize, and run various commands, enhancing efficiency and automation.

Key Features:

  • YAML-Defined Commands: Commands are defined in YAML files, providing a structured and human-readable format for specifying command lines, arguments, and descriptions.
  • Organized Command Sets: Group related commands into logical sets for easier management and execution.
  • Simplified Execution: Run commands individually or as sets with a single command or API call.
  • Enhanced Readability: YAML configuration promotes clarity and understanding of command structures.

Benefits:

  • Streamlined Command Execution: Reduce manual effort and errors by defining commands in a structured format.
  • Improved Organization: Group and manage commands logically for better maintainability.
  • Increased Automation: Automate repetitive tasks by running command sets with a single action.
  • Enhanced Clarity: YAML configuration improves readability and understanding of command structures.

Example YAML Configuration:

run:
  description: Run a test
  hello_world:
    command: echo "hello world"
    description: prints hello world into stdout
  list_demo:
    command:
      - echo "Hello"
      - echo "$@"
      - echo "Goodbye"
      - echo "$@"
    description: Multiple prints taking extra args from the command line
list:
  description: list all tests
  command: for i in $(seq 0 10); do echo "[$i]"; done
build:
  description: build some code
  debug:
    command:  sc docker run rdk-dunfell 'echo "Building debug"' 

Use Cases:

  • Running Tests: Execute test suites or individual test cases.
  • Building Code: Automate build processes for different configurations.
  • Managing Docker Containers: Start, stop, and manage Docker containers.
  • System Administration: Perform routine system administration tasks.
  • Any Command-Line Task: Execute any task that can be expressed as a command-line instruction.

xts_core provides a straightforward and efficient way to manage and execute commands, reducing manual effort and improving automation across various tasks and workflows.

Clone this wiki locally