Skip to content
Back to search

network-sketcher

Network Sketcher is an AI-ready network design tool with Local MCP, Online, and Offline editions for creating network designs and exporting PowerPoint diagrams and Excel-based configuration data.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/cisco-open/network-sketcher with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/cisco-open/network-sketcher'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/cisco-open--network-sketcher/badge.svg)](/listings/cisco-open--network-sketcher)

HTML

<a href="/listings/cisco-open--network-sketcher"><img src="/api/listings/cisco-open--network-sketcher/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

The quickest way to try Network Sketcher with an AI agent is the Local MCP edition.

1. Install

git clone https://github.com/cisco-open/network-sketcher/
cd network-sketcher/network-sketcher_local_mcp
python -m pip install -r requirements_mcp.txt

2. Add it to your MCP client

For Cursor, add this to your MCP configuration:

{
  "mcpServers": {
    "network-sketcher": {
      "command": "python",
      "args": [
        "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
      ]
    }
  }
}

For Claude Code:

claude mcp add network-sketcher -- python "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"

Replace `/path/to/network-sketcher/` with your local clone path.

3. Ask your agent to build a network

Example prompt:

Using Network Sketcher Local MCP, create a small 5-site WAN design with HQ, two data centers, two branches, Internet and WAN waypoints, edge routers, simple L2 segments, and representative IP addressing. Then build the default L1/L2/L3 diagrams and device table.

The generated files will be saved in your Network Sketcher workspace.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 546 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <img src="https://github.com/user-attachments/assets/cc82082d-c4a5-4f13-90f5-adaf162202b2" alt="image" />
  3. </p>
  4. <p align="center">
  5. <a href="https://glama.ai/mcp/servers/cisco-open/network-sketcher">
  6. <img src="https://glama.ai/mcp/servers/cisco-open/network-sketcher/badges/score.svg" alt="Glama MCP score" />
  7. </a>
  8. &nbsp;
  9. <a href="https://lobehub.com/mcp/cisco-open-network-sketcher">
  10. <img src="https://lobehub.com/badge/mcp/cisco-open-network-sketcher" alt="LobeHub MCP" />
  11. </a>
  12. </p>
  13. # Network Sketcher
  14. **Network Sketcher is an AI-native network design and diagramming tool. It generates L1/L2/L3 topology diagrams, device tables, and AI-ready context files from structured network data and natural-language workflows.**
  15. For MCP users, **Network Sketcher Local MCP** lets LLM clients such as Cursor and Claude Code design Cisco-style networks directly through Model Context Protocol tool calls. It runs locally over stdio, keeps master files on your machine, and produces SVG / PowerPoint diagrams plus HTML device tables.
  16. If Network Sketcher helps your workflow, please consider starring the repository.
  17. Common use cases:
  18. - Build a 5-site WAN or campus LAN design from an AI conversation
  19. - Generate L1 physical, L2 VLAN/broadcast-domain, and L3 IP topology diagrams
  20. - Export a combined L1/L2/L3 HTML viewer and an interactive device table
  21. - Create an AI Context file so another LLM can review or extend the network design
  22. - **Import from live inventory:** Use [Network Sketcher Cisco Extension](https://github.com/CiscoDevNet/network-sketcher-cisco-extension) converters to turn ACI, Catalyst Center, Catalyst SD-WAN, Meraki, Nexus Dashboard, CML, Cyber Vision, SNA, NetBox exports, or config files (IOS / IOS-XE / NX-OS / IOS-XR / ASA) into CLI commands for any Network Sketcher edition
  23. ## Quick Start: Local MCP in 3 Steps
  24. <img alt="ns_demo_mcp" src="https://github.com/user-attachments/assets/1b9a85f9-0785-4dbb-b980-68ec0c1f31c9" />
  25. The quickest way to try Network Sketcher with an AI agent is the Local MCP edition.
  26. ### 1. Install
  27. ```bash
  28. git clone https://github.com/cisco-open/network-sketcher/
  29. cd network-sketcher/network-sketcher_local_mcp
  30. python -m pip install -r requirements_mcp.txt
  31. ```
  32. ### 2. Add it to your MCP client
  33. For Cursor, add this to your MCP configuration:
  34. ```json
  35. {
  36. "mcpServers": {
  37. "network-sketcher": {
  38. "command": "python",
  39. "args": [
  40. "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  41. ]
  42. }
  43. }
  44. }
  45. ```
  46. For Claude Code:
  47. ```bash
  48. claude mcp add network-sketcher -- python "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  49. ```
  50. Replace `/path/to/network-sketcher/` with your local clone path.
  51. ### 3. Ask your agent to build a network
  52. Example prompt:
  53. ```text
  54. Using Network Sketcher Local MCP, create a small 5-site WAN design with HQ, two data centers, two branches, Internet and WAN waypoints, edge routers, simple L2 segments, and representative IP addressing. Then build the default L1/L2/L3 diagrams and device table.
  55. ```
  56. The generated files will be saved in your Network Sketcher workspace.
  57. <img alt="image" src="https://github.com/user-attachments/assets/26068524-6293-4f7f-ab0c-f6b7e2c8b842" />
  58. <img alt="image" src="https://github.com/user-attachments/assets/b3501923-195e-45bc-9120-f6b78396e300" />
  59. ## Ecosystem & Integrations
  60. Network Sketcher Local MCP is listed on the official MCP Registry and major MCP platforms:
  61. - **Registries:** [MCP Registry](https://registry.modelcontextprotocol.io/?q=network-sketcher) · [Glama](https://glama.ai/mcp/servers/cisco-open/network-sketcher) · [PulseMCP](https://www.pulsemcp.com/servers/network-sketcher)
  62. - **Hubs:** [LobeHub](https://lobehub.com/mcp/cisco-open-network-sketcher)
  63. Network Sketcher provides three editions:
  64. - [**Network Sketcher Local MCP**](#network-sketcher-local-mcp) — **AI-native MCP server for LLM clients (Cursor, Claude Code, etc.)**. The most direct AI integration: the LLM calls Network Sketcher tools without a browser or copy-paste.
  65. - [**Network Sketcher Online**](#network-sketcher-online) — Browser-based web service.
  66. - [**Network Sketcher Offline**](#network-sketcher-offline) — Desktop GUI + CLI. Runs independently with the `network-sketcher_offline/` folder alone.
  67. You can use any combination.
  68. | | **Local MCP (AI-native)** | Online (Web Service) | Offline (GUI + CLI) |
  69. | --- | --- | --- | --- |
  70. | Interface | **LLM client (Cursor, Claude Code, etc.)** | Web browser | Desktop GUI / Command-line |
  71. | Key dependencies | **Python + MCP SDK** | Python + Flask | Python + tkinter |
  72. | Multi-user | Single user | Multiple users via browser | Single user |
  73. | Client requires | **Python + MCP client** | Web browser only | Python runtime environment |
  74. | AI-native design | **Yes (most direct)** | Yes | No |
  75. | Master format | **`.nsm` only** | `.xlsx` / `.nsm` both | `.xlsx` only |
  76. | Internal data storage | No | No | No |
  77. | External communication | stdio to LLM client (local) | [HTTPS](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Online_Edition)%5BEN%5D#external-communication) | No |
  78. | Tested platforms | Windows (Mac OS, Linux compatible by design) | Windows (Mac OS, Linux untested) | Windows, Mac OS, Linux |
  79. | Folder | **`network-sketcher_local_mcp/`** | `network-sketcher_online/` | `network-sketcher_offline/` |
  80. ```
  81. network-sketcher/
  82. ├── network-sketcher_local_mcp/ # Local MCP edition — MCP server for LLM clients (AI-native)
  83. ├── network-sketcher_online/ # Online edition — Web service (browser-based)
  84. ├── network-sketcher_offline/ # Offline edition — GUI + CLI (standalone desktop app)
  85. ├── README.md
  86. ├── LICENSE
  87. └── ...
  88. ```
  89. ## Extensions: Cisco & Third-Party Converters
  90. The [Network Sketcher Cisco Extension](https://github.com/CiscoDevNet/network-sketcher-cisco-extension) repository (Cisco DevNet) is a **separate monorepo** of converters that turn platform exports or read-only API snapshots into Network Sketcher CLI command scripts (`ns_commands.txt`). The output works with **all three editions** — Local MCP, Online, and Offline (GUI / CLI).
  91. **Converters:** [ACI](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/aci_converter) · [Catalyst Center](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/catc_converter) · [Catalyst SD-WAN](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/sdwan_converter) · [CML](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/cml_converter) · [Cyber Vision](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/cv_converter) · [Meraki](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/meraki_converter) · [Nexus Dashboard (NDFC)](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/nd_converter) · [Secure Network Analytics](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/sna_converter) · [NetBox](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/3rd_party/netbox_converter) · [template_converter](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/template_converter)
  92. **Learn more:** [Typical workflow](https://github.com/CiscoDevNet/network-sketcher-cisco-extension#running-the-output-in-network-sketcher) · [Tools overview](https://github.com/CiscoDevNet/network-sketcher-cisco-extension#tools-in-this-extension) · [Third-party converters](https://github.com/CiscoDevNet/network-sketcher-cisco-extension#community--third-party-converters) · [Build your own converter](https://github.com/CiscoDevNet/network-sketcher-cisco-extension/tree/main/template_converter)
  93. With **Local MCP**, an AI agent can run a converter, feed `ns_commands.txt` through `run_commands`, and finalize with `build_default_outputs` in one session.
  94. > Converter output is a **starting draft** — see the [Cisco Extension README](https://github.com/CiscoDevNet/network-sketcher-cisco-extension) for data-quality caveats and validation guidance.
  95. <br>
  96. <br>
  97. <p align="center">━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</p>
  98. <br>
  99. # Network Sketcher Local MCP
  100. > **AI-native edition:** Network Sketcher Local MCP exposes the engine as a **Model Context Protocol (MCP) server**, enabling LLM clients such as Cursor and Claude Code to drive network design directly. This is the most direct AI integration of the three editions — no browser, no copy-paste.
  101. <img alt="image" src="https://github.com/user-attachments/assets/6f3db3ba-4f92-401d-8f75-4c09cc0f185d" />
  102. ## What is Network Sketcher Local MCP?
  103. Network Sketcher Local MCP is the third edition of Network Sketcher. It wraps `network-sketcher_online/ns_engine/` as a library and exposes the Network Sketcher CLI through the Model Context Protocol so that LLM clients can drive network design via Tool calls.
  104. > **Positioning:** The Online edition is "browser + human + LLM (copy-paste)"; the Offline edition is "desktop GUI / CLI"; this edition is **"AI-native — the LLM executes the CLI directly"**.
  105. ## 5min Demo video of the Local MCP edition.
  106. The AI ​​agent Cursor autonomously creates a network using Network Sketcher's Local MCP functionality. It also simultaneously references best practices from other MCPs.
  107. https://github.com/user-attachments/assets/274d5b66-5f4a-407a-bfb5-f71026971fc4
  108. ## Local MCP Features
  109. - **No browser, no copy-paste.** The LLM calls `add device ...` and similar commands as Tool invocations
  110. - Reuses `network-sketcher_online/ns_engine/` **as a library** (no code duplication)
  111. - **No changes** are made to the existing `_online` / `_offline` folders
  112. - stdio transport (designed for local operation)
  113. - **Platform import workflow:** See [Extensions: Cisco & Third-Party Converters](#extensions-cisco--third-party-converters) above (`run_commands` + `build_default_outputs`)
  114. ## Limitations (Local MCP)
  115. - Single-user edition designed to run on a local PC
  116. - Only stdio transport is supported (HTTP/SSE not supported)
  117. - Diagram generation for large networks may take some time
  118. - LLM clients cannot directly view binary output (PPTX / SVG); if visual feedback is needed, the user should open the generated SVG directly
  119. - **Verification status:** End-to-end verified in both Cursor and Claude Code. The server follows the standard MCP specification, so any MCP-compatible AI agent/client is expected to work, not just these two.
  120. ## Requirement (Local MCP)
  121. - Python 3.10 or later (required by the MCP SDK; the engine itself supports 3.9+)
  122. - The full Network Sketcher repository (the `network-sketcher_online/` folder must be present)
  123. - **Recommended LLM: Claude Opus 4.7 or later.** The Local MCP edition relies heavily on multi-step tool calling, schema interpretation, and adherence to the layout / workflow rules embedded in the server instructions and AI Context (e.g., RULE 0 / 0.5 layout, RULE 3.5 multi-transport WAN waypoint design, mandatory `get_workspace_info` to `get_ai_context` bootstrap). Weaker or older models may struggle with these workflows.
  124. ## Installation (Local MCP)
  125. ```bash
  126. git clone https://github.com/cisco-open/network-sketcher/
  127. cd network-sketcher/network-sketcher_local_mcp
  128. python -m pip install -r requirements_mcp.txt
  129. ```
  130. ## Connection Examples
  131. Cursor and Claude Code use different configuration mechanisms, so the setup steps are split below. Pick the one that matches your client.
  132. ### For Cursor
  133. Add the following to the Cursor MCP configuration file (`File > Preferences > Cursor Settings > MCP` → `mcp.json`):
  134. ```json
  135. {
  136. "mcpServers": {
  137. "network-sketcher": {
  138. "command": "python",
  139. "args": [
  140. "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  141. ]
  142. }
  143. }
  144. }
  145. ```
  146. Replace `/path/to/network-sketcher/` with the actual path where you cloned the repository.
  147. On Windows, you can use either forward slashes (`/`) or escaped backslashes (`\\`).
  148. ### For Claude Code
  149. Register the MCP server with the `claude` CLI. The `--` (double dash) separator is required so that the script path is passed to `python` rather than parsed as a flag of `claude mcp add`:
  150. ```bash
  151. # Local scope (default; current project only, stored in ~/.claude.json)
  152. claude mcp add network-sketcher -- python "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  153. # User scope (available across all your projects)
  154. claude mcp add --scope user network-sketcher -- python "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  155. # Project scope (shared with team via .mcp.json in project root)
  156. claude mcp add --scope project network-sketcher -- python "/path/to/network-sketcher/network-sketcher_local_mcp/ns_mcp_server.py"
  157. ```
  158. Replace `/path/to/network-sketcher/` with the actual path where you cloned the repository. See the [Claude Code MCP installation scopes documentation](https://docs.claude.com/en/docs/claude-code/mcp#mcp-installation-scopes) for details on each scope and when to use which.
  159. ## User Guide (Local MCP)
  160. | Language | Link |
  161. | ------------- | ------------- |
  162. | English | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Local_MCP_Edition)%5BEN%5D) |
  163. | Japanese | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Local_MCP_Edition)%5BJP%5D) |
  164. <br>
  165. <br>
  166. <p align="center">━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</p>
  167. <br>
  168. # Network Sketcher Online
  169. > **AI-native software:** Network Sketcher Online is designed around AI (LLM) interaction — generate AI context, send it to an LLM, and paste the resulting commands back to update your network design, all within the browser.
  170. <img alt="image" src="https://github.com/user-attachments/assets/cd645a8b-9661-4f74-8bf3-cd12b3395c82" />
  171. ### Demo Video (Ver 3.0.1b)
  172. A demo video of approximately 4 minutes, starting with the installation of Network Sketcher. This demo video demonstrates creating a network configuration using LLM from URL information and performing additional editing. No sound, no captions.
  173. https://github.com/user-attachments/assets/2acaea3b-32f2-4ff0-90ad-a3dc810293d2
  174. ## What is Network Sketcher Online?
  175. Network Sketcher Online is a browser-based web service. It wraps the Network Sketcher CLI and provides an intuitive web UI for diagram generation and AI-driven network design — no python on PCs required.
  176. ## Online Features
  177. Network Sketcher Online supports two output modes:
  178. - **SVG Mode** (default): Diagrams are rendered as SVG in the browser. All diagrams (L1/L2/L3, all areas and per-area) are generated in parallel and displayed as thumbnails without needing to download individual files. Master files are stored in the high-performance `.nsm` format internally. SVG mode is approximately 30x faster than PPTX mode. For compatibility with the Offline edition, master files can also be downloaded in `.xlsx` format.
  179. - **PPTX Mode**: Diagrams are generated as PowerPoint (.pptx) files, and device files are generated as Excel (.xlsx) files. This is the original output mode and produces the same files as the Offline edition.
  180. - **All uploaded and generated files are automatically deleted from Network Sketcher Online after the session ends — no data is retained on the server.**
  181. - Upload master files via drag-and-drop in a web browser
  182. - Generate L1/L2/L3 diagrams, device files, and AI context files with selectable outputs
  183. - **Multi-format diagram download**: SVG / SVG (for Visio) / draw.io / **draw.io (stencil)** — the last variant auto-applies Cisco `mxgraph.cisco.*` stencils
  184. - In-browser preview for PowerPoint (.pptx) and Excel (.xlsx) files without requiring Office software
  185. - Copy AI context to clipboard and open LLM with one click
  186. - Describe desired changes in a prompt field; the AI context + prompt is copied together for LLM interaction
  187. - Update master files by pasting CLI commands from LLM output (Update Master)
  188. - Create new master files from scratch via the web UI
  189. - Parallel processing for faster diagram generation
  190. - Attribute-based device coloring for L1 and L3 diagrams
  191. - Session persistence across browser refreshes with automatic cleanup
  192. - HTTPS enforced with auto-generated self-signed certificates
  193. - All settings managed via `ns_web_config.json`
  194. ## Limitations (Online)
  195. - Designed for use on internal networks only. Not intended for deployment on the public internet.
  196. - IPv4 and IPv6 are supported. IPv6 link-local (fe80::/10), multicast, loopback, unspecified, IPv4-mapped and site-local addresses, and zone index notation (%), are not accepted or drawn. Diagram size and spacing are not adjusted for long IPv6 addresses.
  197. - Excel (.xlsx) and PowerPoint (.pptx) files cannot be synced back to the master file. All editing is performed through CLI commands generated by an LLM.
  198. - In-browser preview for PowerPoint (.pptx) may not render correctly when the browser zoom or display scaling is set to a high value (e.g., 200%).
  199. ## Requirement (Online)
  200. - __Tested on Windows only.__ It may work on Mac OS and Linux, but these platforms have not been verified.
  201. - Other requirements are the same as [Network Sketcher Offline](#requirement-offline).
  202. ## Installation (Online)
  203. ```bash
  204. git clone https://github.com/cisco-open/network-sketcher/
  205. cd network-sketcher/network-sketcher_online
  206. python3 -m pip install -r requirements_online.txt
  207. cd ..
  208. python3 start_ns_online.py
  209. ```
  210. Open the URL shown at startup (default: `https://localhost:5443`) in your browser.
  211. - To serve on a specific network interface, edit the `host` and `port` settings in `ns_web_config.json` before starting the server.
  212. - If no SSL certificate exists, a self-signed certificate is auto-generated on first startup.
  213. - If you change the host IP address or other settings in `ns_web_config.json`, manually delete the SSL certificate files in the `Certs/` folder and restart the server. A new certificate matching the updated settings will be auto-generated.
  214. - If the `fqdn` setting in `ns_web_config.json` is configured, the auto-generated SSL certificate's Common Name (CN) will use the specified FQDN.
  215. ## User Guide (Online)
  216. | Language | Link |
  217. | ------------- | ------------- |
  218. | English | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Online_Edition)%5BEN%5D) |
  219. | Japanese | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Online_Edition)%5BJP%5D) |
  220. ## Performance Measurement Summary (Online)
  221. | Ver: 3.0.1 (SVG Mode) | 64 NW devices<br>112 Connections | 256 NW devices<br>480 Connections | 1024 NW devices<br>1984 Connections | 4096 NW devices<br>8064 Connections |
  222. |--------------------------------------------------------------------------------|------------------:|-------------------:|--------------------:|--------------------:|
  223. | Master file creation *1 | 4s | 4s | 26s | 8m 12s |
  224. | Creation of all configuration diagrams, device tables, and AI Context files | 3s | 7s | 58s | 15m 42s |
  225. ---
  226. *1 Reflect only L1 information in the no_data master file. Connect adjacent devices. Measure command execution time.<br>
  227. Test environment: Intel Core Ultra 7 (1.70 GHz), 32.0 GB RAM, Windows 11 Enterprise <br>
  228. <br>
  229. <br>
  230. <p align="center">━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</p>
  231. <br>
  232. # Network Sketcher Offline
  233. ## Overview
  234. https://github.com/user-attachments/assets/9ff207f8-c6b3-4584-b166-98ae4e4c8297
  235. NoLang (no-lang.com)
  236. Otologic (https://otologic.jp) CC BY 4.0
  237. ## Demo video of basic usage
  238. https://github.com/cisco-open/network-sketcher/assets/13013736/b76ec8fa-44ad-4d02-a7c2-579f67ad24a9
  239. ## AI(LLM) utilization demo video
  240. [Full_Version_link(Youtube)](https://www.youtube.com/watch?v=g5N3yg0jMSg)
  241. https://github.com/user-attachments/assets/5874411a-0e6d-485d-9f85-4cdc85f3ca07
  242. ## Concept
  243. **Network Sketcher generates network configuration diagrams in PowerPoint and manages configuration information in Excel. Additionally, exporting a AI ​​context can be used to generate config files using LLM.**
  244. * Automatic generation of each configuration document by metadatization of network configuration information
  245. * Automated synchronization between documents
  246. * Minimize maintenance and training load by automatic generation of common formats
  247. * Facilitate automatic analysis, AI utilization, and inter-system collaboration by metadatization of configuration information.
  248. * Template support for equipment configuration
  249. ![image](https://github.com/user-attachments/assets/9f497061-08ee-4c78-9040-d5b37d2f3e69)
  250. ![image](https://github.com/cisco-open/network-sketcher/assets/13013736/240ddee0-823d-472f-87d4-8ae7eb1fff7d)
  251. ## New Features (Offline)
  252. - Ver 2.6.1<br>
  253. [Network Sketcher Ver 2.6.1 supported the creation of a network configuration with LLM from scratch](https://github.com/cisco-open/network-sketcher/wiki/1%E2%80%905.-Examples-of-General%E2%80%90Purpose-AI-(LLM)-usage-(config-creation,-config-reflection,-analysis,-etc.)_en)
  254. <img alt="image" src="https://github.com/user-attachments/assets/761072de-d64b-4772-bdc7-6224f53fddd8" />
  255. - Ver 2.6.0<br>
  256. [Network Sketcher Ver 2.6.0 now supports master file conversion from Visio, draw.io, NetBox, and CML data to Network Sketcher.](https://github.com/cisco-open/network-sketcher/wiki/1%E2%80%904.-Convert-data-from-other-systems-into-master-files-(Visio,-draw.io,-NetBox-and-CML)_en)
  257. <img alt="image" src="https://github.com/user-attachments/assets/436a1462-bdf7-49cf-bc4f-235be6cb7d42" />
  258. Although Network Sketcher now supports multiple formats, it is not intended to replace the main drawing tool, but rather aims for mutually beneficial development.
  259. For API-driven platform imports, see [Extensions: Cisco & Third-Party Converters](#extensions-cisco--third-party-converters) above (complements Offline GUI import for Visio / draw.io / NetBox files).
  260. - Ver 2.5.0
  261. - [Communication flow management functionality has been added.](https://github.com/cisco-open/network-sketcher/wiki/9%E2%80%901.Exporting-Flow-files)
  262. ![image](https://github.com/user-attachments/assets/8683c172-505e-4af8-a87a-dc1a1a86a121)
  263. ## Limitations (Offline)
  264. - IPv4 and IPv6 are supported. IPv6 link-local (fe80::/10), multicast, loopback, unspecified, IPv4-mapped and site-local addresses, and zone index notation (%), are not accepted or drawn. Diagram size and spacing are not adjusted for long IPv6 addresses. Auto IP Addressing assigns IPv4 only.
  265. - A DEVICE file contains multiple sheets, but only one sheet should be updated at a time. Simultaneous synchronization of multiple sheet updates is not supported.
  266. - Do not use Network Sketcher on master files in your One Drive folder.
  267. - Deleting Layer 1 links using the GUI cannot identify individual interfaces and will delete more Layer 2 data than intended. Use the CLI command (delete l1_link) to delete Layer 1 links.
  268. ## Requirement (Offline)
  269. - __Network Sketcher supports cross-platform. Works with Windows, Mac OS, and Linux.__
  270. - MAC OS may not display well in Dark mode.
  271. - __Python ver 3.x__
  272. - __Software that can edit .pptx and .xlsx files__
  273. - Microsoft Powerpoint and Excel are the best
  274. - Google Slides and Spreadsheets import/export functionality is available. Excel functions display will show an error, but it works fine.
  275. - Libre Office and Softmaker office cannot be used.
  276. ## Installation (Offline)
  277. ```bash
  278. git clone https://github.com/cisco-open/network-sketcher/
  279. cd network-sketcher/network-sketcher_offline
  280. python3 -m pip install -r requirements_offline.txt
  281. python3 network_sketcher.py
  282. ```
  283. or
  284. ```bash
  285. #Download via browser
  286. https://github.com/cisco-open/network-sketcher/archive/refs/heads/main.zip
  287. #Unzip the ZIP file and execute the following in the prompt of the folder
  288. cd network-sketcher_offline
  289. python3 -m pip install -r requirements_offline.txt
  290. python3 network_sketcher.py
  291. ```
  292. ### Installation Supplement (Offline)
  293. * Alternative to "python -m pip install -r requirements_offline.txt"
  294. ```bash
  295. python3 -m pip install tkinterdnd2
  296. python3 -m pip install "openpyxl>=3.1.3,<=3.1.5"
  297. python3 -m pip install python-pptx
  298. python3 -m pip install ipaddress
  299. python3 -m pip install numpy
  300. python3 -m pip install networkx
  301. python3 -m pip install svg.path
  302. ```
  303. * Mac OS requires the following additional installation.
  304. ```bash
  305. brew install tcl-tk
  306. brew install tkdnd
  307. ```
  308. * Ubuntu requires the following additional installation.<br>
  309. GUI drag and drop doesn't work on Ubuntu, you need to compile tkdnd from source or use "Browse" and "Submit".
  310. ```bash
  311. sudo apt-get install python3-tk
  312. ```
  313. ## User Guide (Offline)
  314. | Language | Link |
  315. | ------------- | ------------- |
  316. | English | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Offline_Edition)%5BEN%5D) |
  317. | Japanese | [Link](https://github.com/cisco-open/network-sketcher/wiki/User_Guide(Offline_Edition)%5BJP%5D) |
  318. <br>
  319. ## How to create the exe file for Windows using pyinstaller
  320. ```bash
  321. pyinstaller.exe [file path]/network-sketcher_offline/network_sketcher.py --onefile --collect-data tkinterdnd2 --additional-hooks-dir [file path] --clean --add-data "./ns_extensions_cmd_list.txt;." --add-data "./ns_logo.png;."
  322. ```
  323. <br>
  324. ## Performance Measurement Summary (Offline)
  325. | Ver: 2.6.1b | 64 NW devices<br>112 Connections| 256 NW devices<br>480 Connections | 1024 NW devices<br>1984 Connections|
  326. |----------------------------------------------------|-----------:|------------:|-------------:|
  327. | Master file creation *1 | 51s | 2m45s | 25m45s |
  328. | Layer 1 diagram generation (All Areas with tags) | 6s | 29s | 6m30s |
  329. | Layer 2 diagram generation | 13s | 51s | 6m53s |
  330. | Layer 3 diagram generation (All Areas) | 10s | 56s | 14m23s |
  331. | Device file export | 19s | 1m4s | 5m14s |
  332. ---
  333. *1 Reflect only L1 information in the no_data master file. Connect adjacent devices. Measure command execution time.<br>
  334. Test environment: Intel Core Ultra 7 (1.70 GHz), 32.0 GB RAM, Windows 11 Enterprise <br>
  335. <br>
  336. <p align="center">━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</p>
  337. <br>
  338. # Appendix
  339. ## Feature Support Matrix
  340. | Feature Item | **Local MCP (LLM-driven CLI)** | Online Edition | Offline Edition (GUI) | Offline Edition (CLI) |
  341. | --- | --- | --- | --- | --- |
  342. | Create master file from PowerPoint rough sketch | ❌ | ❌ | ✅ | ❌ |
  343. | Convert from Visio / Draw.io / NetBox files (built-in Offline GUI) | ❌ | ❌ | ✅ | ❌ |
  344. | Import via [Cisco Extension](#extensions-cisco--third-party-converters) converters (see above) | ✅ | ✅ | ✅ | ✅ |
  345. | Place / create / delete / modify areas, devices, waypoints | ✅ | ✅ | ✅ (areas auto-placed in GUI) | ✅ |
  346. | Add / delete / modify Layer 1 connections (port names, duplex, etc.) | ✅ | ✅ | ⚠️ (port cannot be specified on delete) | ✅ |
  347. | Change Layer 2 segments (VLAN) / add / delete virtual ports (SVI, loopback, port-channel) | ✅ | ✅ | ✅ | ✅ |
  348. | Change IP addresses / Layer 3 instances (VRF) | ✅ | ✅ | ✅ | ✅ |
  349. | Change attributes | ✅ | ✅ | ✅ | ✅ |
  350. | Add / delete VPNs | ❌ | ❌ | ✅ | ❌ |
  351. | Flow management | ❌ | ❌ | ✅ | ❌ |
  352. | Export various reports | ✅ (IP Address only) | ✅ (IP Address only) | ✅ | ❌ |
  353. | Export empty master files (no data) | ✅ | ✅ | ❌ | ✅ |
  354. | Export AI context files | ✅ | ✅ | ✅ | ✅ |
  355. | Export device files | ✅ | ✅ | ✅ | ✅ |
  356. | Generate L1/L2/L3 topology diagrams | ✅ | ✅ | ✅ | ✅ |
  357. | Export diagrams as SVG (Visio-compatible) / draw.io (with Cisco stencils) | ❌ | ✅ | ❌ | ❌ |
  358. > For Cisco Extension import caveats, see [Extensions: Cisco & Third-Party Converters](#extensions-cisco--third-party-converters) above.
  359. ## SAMPLE
  360. ### - Supports various connections
  361. <img alt="image" src="https://github.com/user-attachments/assets/752a5a6d-fcb8-4bf2-a709-91c4c8f862c5" />
  362. Download : [Sample.figure5.zip](https://github.com/user-attachments/files/24335488/Sample.figure5.zip)
  363. ### - Wi-Fi office
  364. Created by using AI context and giving AI (LLM) multiple command generation instructions.
  365. <img alt="image" src="https://github.com/user-attachments/assets/36ca6a28-e0a6-4e3a-94e1-241bd74a86f0" />
  366. Download : [Sample Office.zip](https://github.com/user-attachments/files/24340917/Sample.Office.zip)
  367. ---
  368. <sub>Otologic (https://otologic.jp) CC BY 4.0</sub>
  369. # Author
  370. * Yusuke Ogawa - Architect, Cisco | CCIE#17583
  371. # License
  372. SPDX-License-Identifier: Apache-2.0
  373. Copyright 2023 Cisco Systems, Inc. and its affiliates
  374. Licensed under the Apache License, Version 2.0 (the "License");
  375. you may not use this file except in compliance with the License.
  376. You may obtain a copy of the License at
  377. http://www.apache.org/licenses/LICENSE-2.0
  378. Unless required by applicable law or agreed to in writing, software
  379. distributed under the License is distributed on an "AS IS" BASIS,
  380. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  381. See the License for the specific language governing permissions and
  382. limitations under the License.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.