# Shell – översikt & installation

> AccordionShell är CLI-verktyget för att styra Accordion-stationer. Installation, snabbstart och alla kommandon (verb).

_Källa: E-Sharp (esharp.se) · Accordion Shell (CLI)_


## 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:

```bash
dotnet tool install -g AccordionQ2.Shell
```

To update or uninstall:

```bash
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:

```bash
accordionshell [verb] [options]
```

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

### Basic Workflow

```bash
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](/accordion/support/docs/shell-init) — initialize connection to Accordion hardware
- [list](/accordion/support/docs/shell-list) — list all channels and their values
- [get](/accordion/support/docs/shell-get) — get channel values with performance metrics
- [set](/accordion/support/docs/shell-set) — set channel values
- [reset](/accordion/support/docs/shell-reset) — reset the Accordion system
- [exit](/accordion/support/docs/shell-exit) — exit the application
- [docs](/accordion/support/docs/shell-docs) — view comprehensive command documentation

### Channel Configuration

- [conf](/accordion/support/docs/shell-conf) — configure channel properties
- [wait](/accordion/support/docs/shell-wait) — wait for a channel to reach a value
- [alias](/accordion/support/docs/shell-alias) — manage alias configuration files

### Module Management

- [module](/accordion/support/docs/shell-module) — load, unload and manage modules

### Bus Operations

- [i2c](/accordion/support/docs/shell-i2c) — perform I2C transactions (read, write, scan)

### Data Analysis

- [num](/accordion/support/docs/shell-num) — numeric result channels and statistical analysis

### Media Management

- [media](/accordion/support/docs/shell-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`.
