MXFlow

a CICD for internal processes and workflows on local machines for teams

group commands under a workflow, write steps, use special commands like confirm

💥 Unopinionated config based workflow engine

🗃️ Streamline complex workflows across teams

💡 Simplify complex commands

Special commands

• confirm {command} adds a confirmation step to any commands
• autocomplete checkout {pattern} prompt checkout the pattern branch
• list logs list last n pretty git graph log

Config order

• ./.mxflow/config.yml
• ~/.config/mxflow/config.yml

config_version: 0.47.0
sleep_between_commands: 1000
workflows:
  foobar:
    description: example placeholder
    pattern: '{branchType}/{taskId}-{description}'
    steps:
      - git fetch origin
      - git checkout master
      - git merge origin/master
      - autocomplete checkout xorg
      - git checkout -b {branchName}
      - git status
      - confirm git push --set-upstream origin {branchName}
      - list logs
  xorg:
    description: example placeholder
    steps:
      - echo hello word
      - echo goodbye cruel world
      - confirm echo goodbye

sample usecase: git-workflow

Requirements

• Node 16.x

Installation

npm i -g mxflow

or

npx mxflow

Usage

mxflow # or mxf
mxflow --trigger foobar
mxflow --trigger feature --branch feat/xorg
mxflow --trigger hotfix --branch hotfix/zelda --verbose
mxflow --no-catch-git # to bypass initial git checks

Options

--verbose                 | verbose logs
--trigger <workflow-name> | non-interactive workflow trigger
--branch <branch-name>    | branch name for non-interactive flow
--no-catch-git            | bypass initial git checks

Roadmap

• project based config file
• plugin system for dynamic lists
• aurgument mode
• argument autocomplete

        ___           ___           ___
       /__/\         /__/|         /  /\
      |  |::\       |  |:|        /  /:/_
      |  |:|:\      |  |:|       /  /:/ /\
    __|__|:|\:\   __|__|:|      /  /:/ /:/
   /__/::::| \:\ /__/::::\____ /__/:/ /:/
   \  \:\~~\__\/    ~\~~\::::/ \  \:\/:/
    \  \:\           |~~|:|~~   \  \::/
     \  \:\          |  |:|      \  \:\
      \  \:\         |  |:|       \  \:\
       \__\/         |__|/         \__\/