Enum TagsCommand 

pub enum TagsCommand {
    Provider(TagsProviderCommand),
    Browse {
        path: Option<String>,
        filter: Option<String>,
        include_properties: bool,
        project: String,
        from_export: Option<PathBuf>,
    },
    Read {
        paths: Vec<String>,
        project: String,
    },
    Write {
        path: String,
        value: String,
        project: String,
    },
    Config(TagsConfigCommand),
    Udt(TagsUdtCommand),
    Alarms(TagsAlarmsCommand),
    History(TagsHistoryCommand),
    Export {
        paths: Vec<String>,
        output: Option<PathBuf>,
        format: TransferFormat,
        project: String,
    },
    Import {
        file: PathBuf,
        provider: String,
        format: TransferFormat,
        collision_policy: CollisionPolicy,
        project: String,
    },
}

Variants

Provider(TagsProviderCommand)

Manage tag providers (native config-resource REST — no deployed routes involved): list with tag counts + health, create a STANDARD provider, delete (guarded)

Browse

Browse tags as a tree (Property children filtered by default) — providers appear at the root; needs the deployed routes (ign webdev deploy) — or run fully OFFLINE against an export via –from-export

Fields

path: Option<String>

Tag path to browse from (default: the root — providers)

filter: Option<String>

Case-insensitive substring filter on name and full path

include_properties: bool

Include Property children (filtered out by default)

project: String

Project holding the deployed routes (default ign-cli)

from_export: Option<PathBuf>

Browse an OFFLINE tag export instead of the gateway (no profile, no credential, no routes): the CLI’s own tags export JSON, a legacy <provider>.json whole tree, or a git-module tags/ directory — mutually exclusive with the positional browse path

Read

Read one or more tag values (quality and timestamp included) — needs the deployed routes

Fields

paths: Vec<String>

Tag paths to read, e.g. [default]T1 (one or more)

project: String

Project holding the deployed routes (default ign-cli)

Write

Write a value to a tag — the value is parsed as a JSON scalar (number/bool/null); anything unparseable is sent as a string; arrays/objects refuse — needs the deployed routes

Fields

path: String

Tag path to write, e.g. [default]T1

value: String

Value to write: JSON scalar (42, 1.5, true), else the raw text is sent as a string

project: String

Project holding the deployed routes (default ign-cli)

Config(TagsConfigCommand)

Tag CONFIGURATION CRUD (the surgical edit loop — JSON in, JSON out): get/create/edit/delete tag configs through the deployed tagConfig route; stringified values are re-parsed so agents see real JSON

Udt(TagsUdtCommand)

UDT types and definitions (recursive: parameters + nested children) — needs the deployed routes

Alarms(TagsAlarmsCommand)

Alarm operations: active status (with filters), journal history, acknowledge — needs the deployed routes

History(TagsHistoryCommand)

Tag history queries (historian-backed values) — needs the deployed routes; structurally safe on any rig (data requires a provisioned historian)

Export

Export tag subtrees — json writes the gateway’s native JSON interchange (the lossless round-trip); xml passes the gateway’s own XML through byte-for-byte; csv is CLI-GENERATED and LOSSY (no alarms, legacy 48-column set, numeric enums — the gateway cannot export CSV)

Fields

paths: Vec<String>

Tag paths to export, e.g. [default]P5 (one or more)

output: Option<PathBuf>

Output file (- = stdout — the raw payload, no envelope; default: <last-path-segment>.<ext> in the cwd, ext per format)

format: TransferFormat

Payload format: json (the gateway’s native interchange — default), xml (raw gateway bytes), or csv (CLI-generated and LOSSY: no alarms, legacy columns only, numeric enum coercion — what was dropped prints on stderr)

project: String

Project holding the deployed routes (default ign-cli)

Import

Import a tag export into a target provider — json is the native interchange; xml/csv ride the gateway’s importTags passthrough. A loss scan reports what xml/csv would drop or coerce BEFORE the import and refuses exit 2 unless –yes. Collision behavior: abort (default) refuses on collisions; overwrite replaces them (destructive: requires –yes)

Fields

file: PathBuf

The export file to import (- = stdin)

provider: String

Target tag provider (must exist — ign tags provider create NAME first)

format: TransferFormat

Payload format: json (the gateway’s native interchange — default), xml (gateway XML), or csv (legacy CSV — alarms never arrive; the loss scan reports the gap)

collision_policy: CollisionPolicy

Collision policy: abort refuses when tags already exist (default); overwrite replaces them (destructive: requires –yes). merge is Designer-only (not a value)

project: String

Project holding the deployed routes (default ign-cli)

Trait Implementations

impl Debug for TagsCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for TagsCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for TagsCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand