Verified:GitHub

reverse-external-interfaces

Scan codebase imports to classify and document external dependency interfaces.

52|3|Updated Feb 14, 2026

Search Tags:#automation #documentation #code-analysis #documentation-generation #reverse-engineering #external-interfaces

Ready to run

npx skills add https://github.com/ZTE-AICloud/Co-OmniSpec --skill reverse-external-interfaces

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: reverse-external-interfaces
Source: https://github.com/ZTE-AICloud/Co-OmniSpec/tree/main/skills/reverse-external-interfaces
Command: npx skills add https://github.com/ZTE-AICloud/Co-OmniSpec --skill reverse-external-interfaces

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

外部依赖接口识别与文档生成的编排Skill。用于在代码库中识别来自外部模块且在仓库中有调用示例的接口，并生成标准化文档与汇总数据。

Core Features & Use Cases

识别外部接口：扫描代码库导入/引用，区分系统、本库、外部三类并输出结构化清单。
按需文档生成：仅为在仓库中有调用点的外部接口生成单接口文档和汇总文件。
多阶段输出：输出缓存状态、阶段输出目录，以及用于整合到 omni-doc 的文档结构。
Use Case: 当一个大型项目较多依赖第三方组件时，能快速产出外部接口文档以便审计与维护。

Quick Start

启动外部依赖接口识别与文档生成流程，完成阶段输出后查看生成的接口文档。

Frequently Asked Questions about reverse-external-interfaces

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate documentation for external dependencies in a codebase?▼

To generate external dependency documentation automatically, this Skill scans codebase imports and classifies symbols as system, local, or external, then outputs structured markdown documentation for each external interface with at least one usage.

What is the best way to map external API usage from third-party libraries?▼

The best way to map external API usage is by scanning repository references to detect external modules, generating per-interface markdown files and a summary JSON detailing all external interfaces with active call sites.

How does reverse engineering external interfaces work for code analysis?▼

Reverse engineering external interfaces works by detecting the dominant language in a repository, scanning all import usages, and categorizing symbols to produce structured documentation exclusively for external dependencies.

Can I exclude specific file paths when scanning for external dependencies?▼

Yes, you can exclude specific file paths during the external dependency scan. The Skill supports configurable path exclusions and caching to streamline the code analysis process.

Where are the generated external interface docs and summary files stored?▼

Generated external interface docs and summary files are stored under the {REPO_ROOT}/omni-doc/specs/external-interfaces directory, using markdown files prefixed with EXTERNAL-API_ and a EXTERNAL-API_SUMMARY.json file.

Does the external interface documentation generation require interactive confirmation?▼

Interactive confirmation is optional during external interface documentation generation. The Skill can run autonomously to scan imports and output documentation, but allows manual confirmation if preferred.