# Welcome to GNS3 Copilot Documentation

<div align="center">

[🇺🇸 English](README.md) | [🇨🇳 中文](README_ZH.md)

</div>

---

## Overview

**GNS3 Copilot** is an AI-powered network automation assistant designed specifically for GNS3 network simulator. It provides intelligent network device management and automated operations through natural language interaction.

![GNS3 Copilot Demo](https://raw.githubusercontent.com/yueguobin/gns3-copilot/refs/heads/master/demo.gif)

## Quick Links

### 🚀 Getting Started

- [Installation Guide](https://github.com/yueguobin/gns3-copilot#installation-guide)
- [LLM Configuration](user/llm-quick-configuration-guide.md)
- [FAQ](user/FAQ.md)

### 📚 Documentation

- [Project Announcement](project-announcement.md) - Project overview and roadmap
- [Architecture Documentation](architecture/) - System architecture and framework design
- [User Guide](user/) - User guides and configuration instructions
- [Development Guide](development/) - Development resources and testing guides
- [Technical Documentation](technical/) - Technical specifications

### 🤝 Contributing

We welcome contributions from the community! Please follow our branching strategy:

- Submit Pull Requests to the **Development** branch
- Create feature branches from Development: `git checkout -b feature/your-feature-name Development`

## Core Features

- 🤖 **AI-driven conversational interface** - Natural language interaction
- 🔧 **Device configuration management** - Batch configuration for multiple vendor devices
- 📊 **Topology management** - Create, modify, and manage GNS3 network topologies
- 🎨 **Topology visualization** - SVG drawing support for automatic topology generation
- 🔍 **Network diagnostics** - Intelligent troubleshooting and performance monitoring
- 🌐 **Multi-LLM support** - Integration with DeepSeek, OpenAI, Anthropic, XAI, and more

## License

This project uses MIT License - see [LICENSE](https://github.com/yueguobin/gns3-copilot/blob/master/LICENSE) for details.

## Links

- **GitHub Repository**: https://github.com/yueguobin/gns3-copilot
- **PyPI Package**: https://pypi.org/project/gns3-copilot/
- **Issue Tracker**: https://github.com/yueguobin/gns3-copilot/issues

---

<div align="center">

Made with ❤️ by [Guobin Yue](https://github.com/yueguobin)

</div>