EvexiCLI logo

EvexiCLI Evexi

Use this command to install EvexiCLI:
winget install --id=Evexi.EvexiCLI -e

CLI tool to interact with Evexi API

EvexiCLI is a command-line interface (CLI) tool designed to interact with the Evexi API, enabling users to manage and manipulate data associated with their Evexi account efficiently. It provides utilities for tasks such as copying player content, applications, and variables between accounts, offering flexibility and precision in data management.

Key Features:

  • Player Copy Functionality: Copy content, application configurations, and variables from one player to another. Sensitive variables are excluded by default, and existing target variables can be overwritten or preserved based on user input.
  • Interactive Execution: Users can choose to execute operations one target at a time, with the option to prompt for confirmation before proceeding.
  • Target Customization: Specify properties to copy (e.g., content, application, variables) using command-line options for tailored operations.

Audience & Benefit: Ideal for developers and system administrators managing Evexi accounts, EvexiCLI streamlines data migration and management processes. It empowers users to efficiently replicate configurations across multiple players, reducing manual intervention and enhancing operational efficiency.

EvexiCLI is available for installation via winget on Windows, ensuring seamless setup and integration into existing workflows.

README

Evexi CLI

The Evexi CLI helps provides you with some utilities to interact with your Evexi account via our API.

Installation

Evexi CLI is available for macOS, Windows, and Linux.

macOS & Linux

Available via Homebrew:

brew install evexi/tools/evexi-cli

Windows

Available via WinGet package manager:

winget install Evexi.EvexiCLI

Usage/Examples

Player Copy

This commands allows you to copy content, application and variables of a player to other players.

NOTES:

  • Sensitive variables are skipped
  • Variables already present on the target player will be overwritten if present on the source player
  • Variables already present on the target player and not on the source player won't be deleted
OptionDescriptionDefaultRequired
‑‑source:idor‑‑source:deviceSpecify either the source player ID which can be seen in the browser URL when viewing the player on adminordevice ID which can be seen when viewing the player detail on admin or on the actual screen-Yes
‑‑target:idsor‑‑target:devicesSpecify a comma separated list of either the target player IDs which can be seen in the browser URL when viewing the players on admin or device IDs which can be seen when viewing the players' detail on admin or on the actual screens-Yes
‑‑onlySpecify a comma separated list of properties to copy from the source playerValues: content,application,variablescontent,application,variablesNo
‑‑interactiveSpecify whether to execute the copy one target player at a timeUser will be prompted to press ENTER to proceedfalseNo
‑‑helpShow command helpfalseNo

Example copy by player id

evexi player copy --source:id 000000000000000000000001 --target:ids 000000000000000000000002,000000000000000000000001

Example copy by player's device id

evexi player copy --source:device 11111111111111111111111111111111 --target:devices 22222222222222222222222222222222,33333333333333333333333333333333

Support

For support, email development@evexi.technology.

License

Copyright (c) Evexi. All rights reserved.

Licensed under the Apache License 2.0 license.

Versions
0.0.2
0.0.1
Website
License