README.md

CLI

CLI written in rust to provide user experience in runners.

Abilities

Auto detect examples

When run, it will auto detect all examples in image and provide to user multiselect choice to run examples. To make this work each example shall deploy configuration file name.score.json which below layout.

{
    "name": "Name of example",
    "description": "Extensive description",
    "apps": [
        {
            "path": "exec_path",
            "args": [
                // args to be used when running
            ],
            "env": {
                // env to be used when running
            },
            "delay": "number" // Optional delay between two consecutive apps
        },
        {
            // ...
        }
    ]

}

Each example can run multiple executables, providing additional apps configs. This will be started one after another but not blocking each-other.

Alternatively, the configuration file can contain a top-level array of configs, allowing multiple examples to be defined in a single file:

[
    {
        "name": "First example",
        "description": "Description of first example",
        "apps": [
            {
                "path": "exec_path",
                "args": [],
                "env": {}
            }
        ]
    },
    {
        "name": "Second example",
        "description": "Description of second example",
        "apps": [
            {
                "path": "exec_path",
                "args": [],
                "env": {}
            }
        ]
    }
]

You can customize where to look for examples using env SCORE_CLI_INIT_DIR.