Command Line Documentation

epicsarchiver

Command line tool for interacting with the archiver.

Usage

epicsarchiver [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

-h, --hostname <hostname>: Archiver Appliance hostname or IP [default: localhost]

Environment variables

EPICSARCHIVER_HOSTNAME: Provide a default for --hostname

get

Print out data from an archiver cluster.

ARGUMENT pvs What pvs to get data of.

Example usage:

epicsarchiver --hostname archiver-01.example.com get PV_NAME1 PV_NAME2

Usage

epicsarchiver get [OPTIONS] PVS...

Options

--debug

Turn on debug logging

Default:: False

-s, --start <start>: Start time of query [default: 30 seconds ago]

-e, --end <end>: End time of query, [default: now]

-p, --processor-name <processor_name>

PreProcessor to use

Docs at https://epicsarchiver.readthedocs.io/en/latest/user/userguide.html#processing-of-data

Options:: FIRSTSAMPLE | LASTSAMPLE | FIRSTFILL | LASTFILL | MEAN | MIN | MAX | COUNT | NCOUNT | NTH | MEDIAN | STD | JITTER | IGNOREFLYERS | FLYERS | VARIANCE | POPVARIANCE | KURTOSIS | SKEWNESS | LINEAR | LOESS | OPTIMIZED | OPTIMLASTSAMPLE | CAPLOTBINNING | DEADBAND | ERRORBAR

-b, --bin_size <bin_size>: Bin size (mostly in seconds) for preprocessor.

Arguments

PVS: Required argument(s)

search

Search for PV names using regex search patterns.

Optionally specify start and/or end times to only return PVs that recorded data in the specified time range.

ARGUMENT query PV name regex search pattern.

Example usage:

epicsarchiver --hostname archiver-01.example.com search                 "PBI-APTM02:Ctrl-ECAT-100:.*Temp1[2-4].*"

epicsarchiver --hostname archiver-01.example.com search                 "PBI-APTM02:.*" -s "2026-01-06 02:50:00"

epicsarchiver --hostname archiver-01.example.com search                 "(?i)mbl-060RFC:.*:tempambient" -s "2026-01-05"  -e "2026-01-06"

Usage

epicsarchiver search [OPTIONS] QUERY

Options

-s, --start <start>: Start time of query

-e, --end <end>: End time of query

-l, --limit <limit>: Limit of PV names to return for each search string given. To get all the PV names, (potentially in the millions), set limit to -1.

--debug: Turn on debug logging

Arguments

QUERY: Required argument