Shell – overview & installation

AccordionShell is the CLI tool for controlling Accordion stations. Installation, quick start and all commands (verbs).

View as Markdown (for AI/KB)

Overview

AccordionShell is a command-line interface (CLI) tool for interacting with Accordion hardware systems. It provides a comprehensive set of commands (called “verbs”) to initialize connections, configure channels, perform I2C transactions, manage modules, handle media files, and more.

Installation

AccordionShell is distributed as a .NET global tool. Install it using the .NET CLI:

dotnet tool install -g AccordionQ2.Shell

To update or uninstall:

dotnet tool update -g AccordionQ2.Shell
dotnet tool uninstall -g AccordionQ2.Shell

Prerequisites: .NET 8.0 SDK or later, and network access to the Accordion hardware.

Quick Start

Run from any directory:

accordionshell [verb] [options]

Run without arguments to enter interactive mode, where you can type commands and help.

Basic Workflow

init --host <hostname_or_ip>     # 1. connect
list                             # 2. view channels
get --channel <channel_name>     # 3. read
set --channel <channel_name> --value <value>   # 4. write
exit                             # 5. close

Available Commands (Verbs)

Core

  • init — initialize connection to Accordion hardware
  • list — list all channels and their values
  • get — get channel values with performance metrics
  • set — set channel values
  • reset — reset the Accordion system
  • exit — exit the application
  • docs — view comprehensive command documentation

Channel Configuration

  • conf — configure channel properties
  • wait — wait for a channel to reach a value
  • alias — manage alias configuration files

Module Management

  • module — load, unload and manage modules

Bus Operations

  • i2c — perform I2C transactions (read, write, scan)

Data Analysis

  • num — numeric result channels and statistical analysis

Media Management

  • media — upload, download and manage media files

Common Option Patterns

  • Channel selection: --channel / -c
  • File paths: --path / -p
  • Regex filtering: --filter / -f

Tips

  • For rapid testing, use interactive mode (help, then a command name for quick syntax, docs for full docs).
  • For automation, pass command-line arguments or chain commands in scripts. Connection state persists between invocations in interactive mode.
  • All errors are displayed in red; use reset to recover from error states.

Version

This documentation is for AccordionShell distributed as the AccordionQ2.Shell .NET global tool (target framework .NET 8.0 or later). Check your version with dotnet tool list -g.

Book a demo of Probe

Show us your board — we review it and go through the findings together.

Prefer to email? info@esharp.se