Skip to content

Command-Line Tools

The host command-line tools live in host/commandline and are built with the host tools. They are intended for direct USB tag operations and scripting.

In the macOS release they are in tag_tools/bin; put that directory on your PATH to run them by name. In the Windows release they are in tag_tools beside the applications.

These are command-line programs: run them from a terminal, such as Terminal on macOS. Double-clicking one in the macOS Finder does not work, and Finder may report that the program cannot be opened or used. That message does not mean the release is damaged or blocked; the same program runs normally when you type its name in a terminal.

Use these pages as working templates. Fill in the purpose, preconditions, examples, expected output, and troubleshooting details as each tool is reviewed against the current workflow.

Common Options

Most tag-attached tools share these options:

Option Value Function
-d, --debug none Enables debug logging. Without this option, the tools use error-level logging.
-b, --base BUS:DEVICE Selects a specific USB device by bus and device address. Use this when more than one compatible base/tag interface is connected.
-h, --help none Prints command usage and exits.

Tool Pages

Tool Template page Starting point
tag-dwnld tag-dwnld Download finished or aborted tag logs to text or SQLite files.
tag-info tag-info Print tag information, firmware metadata, status/configuration details.
tag-reset tag-reset Stop a running/hibernating tag and erase completed log data.
tag-start tag-start Start logging when a tag is idle.
tag-stop tag-stop Stop active logging states and print the resulting tag status.
tag-cal tag-cal Start calibration mode and stream raw calibration samples.
dataprocessing dataprocessing Copy SQLite logs and add derived sensor streams for later analysis.
tag-txt-import tag-txt-import Convert old BitTag and PresTag .txt logs to SQLite, checking each conversion.
tag-test tag-test Run RTC checks and tag self-tests.

Developer and bench programs -- tag-test-example, tag-monitor-test, tag-attach-cycle, tag-cal-write, tag-peek -- are built from the same directory but are not part of a release, so they have no pages here. They are described in host/commandline/README.md.

Fill-In Checklist

Use the same structure on each tool page:

  1. Replace the placeholder description with the user-facing job the tool performs.
  2. Add preconditions such as required tag state, firmware support, calibration setup, or expected hardware connection.
  3. Add one or more known-good commands.
  4. Paste representative output or describe the output fields.
  5. Add troubleshooting notes for common failure messages.