File size: 2,019 Bytes
173dcbd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | ---
title: "Command Line Interface"
description: "CLI options and usage for Image Matching WebUI"
---
# Command Line Interface
The `imcui` package provides a powerful command-line interface for automation and batch processing.
## Basic Usage
```bash
imcui [OPTIONS]
```
Start the web interface with default settings:
```bash
imcui
```
## Options
| Option | Short | Default | Description |
|--------|-------|---------|-------------|
| `--server-name` | `-s` | `0.0.0.0` | Server hostname/IP |
| `--server-port` | `-p` | `7860` | Server port number |
| `--config` | `-c` | Auto-detect | Configuration file path |
| `--example-data-root` | `-d` | Auto-download | Example datasets directory |
| `--verbose` | `-v` | `False` | Enable verbose output |
| `--version` | | | Show version |
| `--help` | `-h` | | Show help |
## Common Use Cases
### Custom Port
```bash
imcui -p 8080
```
### Local Host Only
```bash
imcui -s 127.0.0.1
```
### Custom Configuration
```bash
imcui -c /path/to/config.yaml
```
### Custom Data Directory
```bash
imcui -d /path/to/datasets
```
### Combine Options
```bash
imcui -s 127.0.0.1 -p 8080 -c my_config.yaml -d /my/data --verbose
```
## Configuration Files
Configuration files use YAML format. Place one of these files in your working directory:
- `app.yaml`
- `config/app.yaml`
Example configuration:
```yaml
defaults:
setting_threshold: 0.1
max_keypoints: 2000
enable_ransac: true
ransac_method: CV2_USAC_MAGSAC
setting_geometry: Homography
```
## Troubleshooting
<AccordionGroup>
<Accordion title="Port Already in Use">
```bash
imcui -p 8081 # Try different port
```
</Accordion>
<Accordion title="Permission Denied">
```bash
imcui -s 127.0.0.1 # Use local host
```
</Accordion>
<Accordion title="Configuration Not Found">
```bash
imcui -c /absolute/path/to/config.yaml
```
</Accordion>
</AccordionGroup>
## Help and Version
```bash
# Display help
imcui --help
# Show version
imcui --version
```
|