@vavanya/cli v0.0.5-alfa
Test automation to go!
VMT-CLI (Vavanya™ CLI)
VMT-CLI is a command-line utility designed to interact with the Vavanya™ platform. It enables users to perform a "walk" of a given set of constructions, referred to as a "street" in the utility's terminology, based on its street ID. The utility also allows users to manage configurations and override API keys as needed.
Table of Contents
Installation
Ensure that Node.js is installed on your system. You can install vmt-cli
globally using npm:
npm install -g @vavanya/cli
Usage
vmt-cli [options] [command]
You can interact with the utility using different options and commands. Use the help command for detailed information on specific features.
vmt-cli help
Output:
Usage: vmt-cli [options] [command]
Vavanya™ CLI x.y.z
Options:
-V, --version output the version number
-k, --api-key <key> Override API key (env: VMT_API_KEY)
-h, --help display help for command
Commands:
config Manage configuration settings
walk [options] <streetId> Execute a given street by its ID
help [command] display help for command
Commands
General Options
-V, --version
: Displays the current version of VMT-CLI.-k, --api-key <key>
: Overrides the API key for the session (can also be set via theVMT_API_KEY
environment variable).-h, --help
: Displays help information for the utility or a specific command.
Managing Configurations
The config
command allows you to manage and adjust the configuration settings of VMT-CLI.
vmt-cli config [options] [command]
Available Options
-h, --help
: Displays help for theconfig
command.
Subcommands
set <key> <value>
: Sets a configuration option (e.g.,vmt-cli config set api_key <your_API_key>
).
Executing Streets
The walk
command is the core feature of VMT-CLI. It executes a given "street" by its ID, which is a set of constructions that can be processed sequentially or in parallel.
Note: the API key must be provided before street execution either via environment variable, or via --api-key
, or set in the configuration file.
vmt-cli walk [options] <streetId>
Available Options
-f, --force
: Forces the walk through all street's entries, regardless of dependencies (default:false
).-c, --concurrency <number>
: Specifies the number of concurrent processes to be used for parallel execution (default:1
).-h, --help
: Displays help for thewalk
command.
Examples
Display the CLI Help
To view general help information for the utility:
vmt-cli help
Override the API Key
You can override the API key in the command line by passing it with the --api-key
option:
vmt-cli walk --api-key YOUR_API_KEY <streetId>
Set a Configuration Option
To set a configuration value (e.g., changing the API endpoint):
vmt-cli config set apiEndpoint https://api.example.com
Execute a Street with Default Options
To perform a walk through a specific street by its ID:
vmt-cli walk <streetId>
Execute a Street with Parallel Processing
To execute a street using 3 concurrent processes:
vmt-cli walk --concurrency 3 <streetId>
Force Execute All Street Entries
To forcefully walk through all entries regardless of dependencies:
vmt-cli walk --force <streetId>
License
VMT-CLI is licensed under the MIT License.