# ensp-cli

**Repository Path**: safegeek/ensp-cli

## Basic Information

- **Project Name**: ensp-cli
- **Description**: 通过命令行操作ensp
- **Primary Language**: Unknown
- **License**: Unlicense
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2026-03-30
- **Last Updated**: 2026-04-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# eNSP CLI

QQ group:808488619

A CLI tool for managing eNSP (Enterprise Network Simulation Platform) topology files and device connections.

## Features

- **Topology Parsing**: Parse eNSP topology files (.topo) with device and connection info
- **Visual Topology**: ASCII art topology diagram based on device coordinates
- **Device Management**: List devices, view connections, auto-discover topology files
- **Interactive Console**: Connect to devices via Telnet for interactive sessions
- **Command Execution**: Execute single commands on devices with output capture
- **Rich Output**: Table, JSON, and visual output formats with syntax highlighting
- **Exit Codes**: Proper exit codes for scripting and automation

## Installation

```bash
pip install ensp-cli
```

Or install from source:

```bash
git clone https://gitee.com/safegeek/ensp-cli.git
cd ensp-cli
pip install -e .
```

## Requirements

- Python 3.10+
- eNSP installed and running (Windows)
- Telnet enabled on eNSP devices

## Usage

### List Devices
![输入图片说明](image.png)
![输入图片说明](1.png)
![输入图片说明](2.png)
![输入图片说明](44.png)
```bash
# Auto-discover topology file in current directory
ensp-cli list

# Specify topology file
ensp-cli list topology.topo

# Show connections
ensp-cli list --show-connections

# Visual topology diagram
ensp-cli list --output visual

# JSON output
ensp-cli list --output json
```

### Interactive Console
![输入图片说明](image3.png)
```bash
# Connect to a device interactively
ensp-cli console Router1

# Specify topology file
ensp-cli console Router1 --topology mylab.topo

# Exit with Ctrl+] or Ctrl+D
```

### Execute Commands
![输入图片说明](image1.png)
```bash
# Execute a single command
ensp-cli exec Router1 "display version"

# With timeout
ensp-cli exec Router1 "display ip interface brief" --timeout 30

# JSON output for scripting
ensp-cli exec Router1 "display version" --output json
```
![输入图片说明](1L0A2UNPG1S%5DWLSV%60H%7D46F4.png)
## Exit Codes

| Code | Meaning |
|------|---------|
| 0 | Success |
| 1 | General error (device not found, connection failed) |
| 2 | File not found |
| 3 | Invalid XML / Parse error |
| 4 | Permission denied |
| 5 | Command timeout |

## Development

```bash
# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run with coverage
pytest --cov=ensp_cli
```

## Project Structure

```
ensp-cli/
├── src/ensp_cli/
│   ├── cli/main.py          # Main CLI entry point
│   ├── commands/            # exec, console commands
│   ├── models/              # Device, Topology, Connection models
│   ├── parser/              # XML topology parser
│   └── telnet_client.py     # Async Telnet client
├── tests/                   # Test suite (173 tests)
└── docs/                    # Documentation
```

## License

MIT License

## Changelog

### v1.0.0 (2026-03-30)

- ✅ Parse eNSP `.topo` XML files
- ✅ List devices with table/JSON/visual output
- ✅ Telnet connection to device consoles
- ✅ Interactive console sessions
- ✅ Single command execution
- ✅ Rich terminal UI with syntax highlighting
- ✅ Comprehensive test suite (173 tests)