> ## Documentation Index
> Fetch the complete documentation index at: https://aegean.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Reference

> Command-line interface for the manufacturing quality control system

# qctl

**Usage**:

```bash theme={null}
qctl [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--debug`: Enable debug mode
* `-v, --version`: Show the application's version and exit.
* `--help`: Show this message and exit.

**Commands**:

* `docs` - Documentation management
* `dataset` - Dataset operations
* `config` - Configuration management

## qctl docs

**Usage**:

```bash theme={null}
qctl docs [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--help`: Show this message and exit.

**Commands**:

* `view`: Parses the documentation files and launches the web server for live-previewing.
* `build`: Parses the CLI code and builds the CLI documentation.

### qctl docs view

Parses the documentation files and launches the web server for live-previewing.

**Usage**:

```bash theme={null}
qctl docs view [OPTIONS]
```

### qctl docs build

Parses the CLI code and builds the CLI documentation.

**Usage**:

```bash theme={null}
qctl docs build [OPTIONS]
```

## qctl dataset

**Usage**:

```bash theme={null}
qctl dataset [OPTIONS] COMMAND [ARGS]...
```

**Commands**:

* `create`: Create the dataset
* `split`: Split dataset into train/test
* `visualize`: Visualize with FiftyOne
* `view`: View with TensorBoard
* `list`: List available datasets
* `index`: Index for semantic search

### qctl dataset create

Create the parquet datasets from raw data.

**Usage**:

```bash theme={null}
qctl dataset create [OPTIONS]
```

**Options**:

* `--save-to TEXT`: Path to save the dataset file (default: `./datafiles`)
* `--help`: Show this message and exit.

### qctl dataset split

Split the dataset into train and test sets.

**Usage**:

```bash theme={null}
qctl dataset split [OPTIONS]
```

**Options**:

* `--description TEXT`: Description of the split operation
* `--overwrite / --no-overwrite`: Recreate and overwrite existing splits (default: `no-overwrite`)
* `--huggingface-hub / --no-huggingface-hub`: Upload to Hugging Face Hub (default: `no-huggingface-hub`)
* `--fiftyone / --no-fiftyone`: Create FiftyOne dataset (default: `no-fiftyone`)
* `--help`: Show this message and exit.

### qctl dataset visualize

Visualize the Seamagine datasets using FiftyOne.

**Usage**:

```bash theme={null}
qctl dataset visualize [OPTIONS] [REPO_ID]
```

**Arguments**:

* `[REPO_ID]`: Hugging Face Hub repository ID (default: `aegean-ai/fo_seamagine`)

**Options**:

* `--remote-server TEXT`: Address of a remote FiftyOne server
* `--help`: Show this message and exit.

### qctl dataset view

View transformed data using TensorBoard.

**Usage**:

```bash theme={null}
qctl dataset view [OPTIONS]
```

**Options**:

* `--dataset-name TEXT`: Path to the dataset parquet file (default: `seamagine.parquet`)
* `--save-to TEXT`: Path to save the tensorboard logs (default: `./runs/transformed_images`)
* `--class-names TEXT`: Class names to view (default: `A`)
* `--with-transforms / --no-with-transforms`: Apply transforms to images (default: `with-transforms`)
* `--num-batches INTEGER`: Number of batches to view (default: `8`)
* `--help`: Show this message and exit.

### qctl dataset list

List the datasets available in the S3 bucket.

**Usage**:

```bash theme={null}
qctl dataset list [OPTIONS]
```

### qctl dataset index

Index the datasets for semantic search.

**Usage**:

```bash theme={null}
qctl dataset index [OPTIONS]
```

## qctl config

**Usage**:

```bash theme={null}
qctl config [OPTIONS] COMMAND [ARGS]...
```

**Commands**:

* `view`: View the configuration

### qctl config view

View the configuration.

**Usage**:

```bash theme={null}
qctl config view [OPTIONS]
```

**Options**:

* `--save-to TEXT`: Path to save the YAML file
* `--include-sections TEXT`: Comma-separated keys to include in the output
* `--help`: Show this message and exit.

***

<Callout icon="pen-to-square" iconType="regular">
  [Edit this page on GitHub](https://github.com/aegean-ai/eaia/edit/main/src/products/applications/anomaly-detection/manufacturing/cli/index.mdx) or [file an issue](https://github.com/aegean-ai/eaia/issues/new/choose).
</Callout>
