CODESYS文本同步
AI Skill Hub 推荐使用：CODESYS文本同步 是一款优质的Agent工作流。AI 综合评分 7.5 分，在同类工具中表现稳健。如果你正在寻找可靠的Agent工作流解决方案，这是一个值得深入了解的选择。
CODESYS文本同步 工作流的设计遵循"最小配置，最大复用"原则：核心逻辑已经封装好，用户只需配置自己的 API Key 和业务参数即可快速上手。工作流内置错误处理和重试机制，在网络波动或 API 限速等情况下仍能稳定运行，适合作为生产环境的自动化基础设施。
在实际部署时，建议先在测试环境中运行 3-5 次，验证各个环节的输出结果符合预期，再部署到生产环境。AI Skill Hub 评分 7.5 分，是同类 Agent 工作流中的精选推荐。
Git友好的CODESYS文本同步，导出项目到ST文件，提高开发效率。
CODESYS文本同步 是一套完整的 AI Agent 自动化工作流方案。通过可视化的节点编排，将复杂的多步骤任务拆解为清晰的自动化流程，实现全程无人值守的智能处理。支持与数百种外部服务和 API 无缝集成，适合构建数据处理管线、业务自动化和 AI 辅助决策系统。
Git友好的CODESYS文本同步，导出项目到ST文件，提高开发效率。
CODESYS文本同步 是一套完整的 AI Agent 自动化工作流方案。通过可视化的节点编排，将复杂的多步骤任务拆解为清晰的自动化流程，实现全程无人值守的智能处理。支持与数百种外部服务和 API 无缝集成，适合构建数据处理管线、业务自动化和 AI 辅助决策系统。
- 可视化 Agent 工作流编排，无需编写复杂代码
- 支持多步骤自动化任务链，实现全流程无人值守
- 与外部 API、数据库和第三方服务无缝集成
- 内置错误处理与自动重试机制，保障稳定运行
- 提供可复用的自动化模板，快速在同类场景部署
- 自动化日常重复性工作，将精力集中于创造性任务
- 构建数据采集 → 处理 → 输出的完整自动化管线
- 实现跨平台、跨系统的数据流转和业务协同
# 方式一：pip 安装（推荐）
pip install cds-text-sync
# 方式二：虚拟环境安装（推荐生产环境）
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install cds-text-sync
# 方式三：从源码安装（获取最新功能）
git clone https://github.com/ArthurkaX/cds-text-sync
cd cds-text-sync
pip install -e .
# 验证安装
python -c "import cds_text_sync; print('安装成功')"
- 访问 GitHub 仓库获取工作流文件
- 在对应平台（Dify / Flowise / Make 等）中找到「导入工作流」功能
- 上传工作流文件
- 按照提示配置必要的环境变量和 API Key
- 运行测试确认流程正常后投入使用
# 命令行使用
cds-text-sync --help
# 基本用法
cds-text-sync input_file -o output_file
# Python 代码中调用
import cds_text_sync
# 示例
result = cds_text_sync.process("input")
print(result)
# cds-text-sync 配置文件示例（config.yml） app: name: "cds-text-sync" debug: false log_level: "INFO" # 运行时指定配置文件 cds-text-sync --config config.yml # 或通过环境变量配置 export CDS_TEXT_SYNC_API_KEY="your-key" export CDS_TEXT_SYNC_OUTPUT_DIR="./output"
cds-text-sync: Professional CODESYS Git Sync
Version: 2.0.1
[!IMPORTANT] Disclaimer: This is a third-party tool. It is NOT an official product of CODESYS Group and is not affiliated with, sponsored by, or endorsed by CODESYS Group. This tool is provided "as is" and is not a replacement for official CODESYS products.
Professional synchronization tooling for CODESYS. Version 2.0 is an XML-first rewrite: CODESYS exports a fresh Native XML snapshot, the external Python 3 engine builds the editable project view, and imports are applied back through targeted CODESYS text APIs plus native XML patches.
Custom object behavior and optional text projections are profile-driven; see profiles/profiles.md.
📖 Script Overview
🚀 Key Features
- XML-First Export:
Project_export.pycaptures.dump/IDE.xml, refreshes the configured view root, and writes.dump/manifest.json. - Compare Reports:
Project_compare.pycaptures.dump/IDE.current.xmland writes.dump/compare_report.jsonwithout changing the open project. - Interactive Review:
Project_compare_ui.pyshows object-level changes in CODESYS, supports diff viewing, and can apply checked import/export actions. - Patch Import:
Project_import.pybuilds.dump/IMPORT.xmlfrom disk edits and applies textual objects through CODESYS text APIs before native XML import handles the rest. - Completion Summaries: Export and import show a final success popup by default, with an option to disable it in
Project_options.py. - Pre-Import Backups: Optional timestamped
.projectbackups are written to.backup/before IDE-changing imports, with a configurable retention count. - Optional
.stProjections: POU, POU child, GVL, persistent variable list, task-local GVL, and DUT text can be emitted as readable.stfiles while duplicated text is removed from the XML sidecar for cleaner PR diffs. - Optional
.csvProjections: Text lists and alarm items can be exported as CSV and imported back for existing-row edits such as translation updates. - Profile-Aware Behavior: JSON profiles describe vendor/fork-specific object kinds, projection availability, and safety rules.
- Diagnostics:
Project_build.py,Project_discover.py, andProject_resources.pyprovide build, environment, profile, and snapshot-size diagnostics. - Legacy Isolation: Older commands and the previous ST-oriented workflow are preserved under
old_scripts/instead of being mixed into the active root command set.
---
Requirements
- Minimum Tested Target: CODESYS V3.5 SP10+ (earlier versions might support scripting but lack essential API features for reliable text syncing).
- Recommended Target: CODESYS V3.5 SP13 and newer.
- Python 3 Required: Version 2.0 uses CODESYS/IronPython only as a thin IDE bridge. Export, compare, import, options, and diagnostics run the external Python 3 engine, so
pythonmust be available from the Windows command line.
Check before running the scripts:
python --versionIf this command is not found, install Python 3 or configure your environment so python points to Python 3.
The quick PowerShell installer also checks for python up front and can offer a manual download page or a winget installation path if it is missing.
---
🛠️ Installation
Method 2: Quick PowerShell Setup (Recommended)
Automate the installation and folder creation for Standard (User Profile) with one command:
irm https://raw.githubusercontent.com/ArthurkaX/cds-text-sync/main/irm/setup.ps1 | iex[!NOTE] - No Git required: This script downloads clean zip archives from GitHub, not the full repository with history. - Choose version: You can select the latest development version, a stable release, or a test / pre-release build from the interactive menu. - Smaller footprint: Installation downloads a clean script archive instead of cloning the full Git history.
[!TIP] For a detailed explanation of what the script does, check the Quick Setup Guide.
[!TIP] Using a different CODESYS version or fork? See the Alternative Installations Guide for supported environments and installation paths.
2. Access in CODESYS: - The scripts will be available in Tools > Scripting > Scripts > P.
3. Add to Toolbar (Recommended): - Go to Tools > Customize > Toolbars. - Add commands from ScriptEngine Commands > P.
---
Follow the installation steps to copy the files
```
Option 2: Download from GitHub Releases 1. Go to GitHub Releases 2. Download the release archive for the stable version 3. Extract and copy the scripts to your CODESYS ScriptDir
[!NOTE] You can also use the Quick PowerShell Setup script (Method 2 above) which automatically downloads stable releases as clean zip archives without requiring Git installation.
1. `Project_directory.py` (Setup)
Run this first. It links your current CODESYS project to a sync root on disk.
- Offers two options:
- Browse: Select a folder using the file browser (traditional method).
- Manual Input: Enter a path manually, supporting both absolute and relative paths.
- Relative Path Support:
- Use
./to sync to the same directory as your project file. - Use
./src/or./foldername/to sync to a subfolder relative to your project. - Perfect for team collaboration: Relative paths work on any machine without reconfiguration, as they're resolved relative to the project file location.
- The folder will be created automatically if it doesn't exist.
- Saves the sync-root path in the CODESYS project properties used by the active scripts.
- The selected sync root is then resolved into generated state such as
.dump/and the editable view root such asproject-view/.
Examples:
- Absolute path:
C:\MyProjects\MyPLC\sync\ - Relative path (project directory):
./ - Relative path (subfolder):
./sync/or./git-repo/src/
🧪 Reference Project & Examples
To keep this repository lightweight and minimalist for users who git clone the scripts, all test cases, problematic objects, and compatibility examples are hosted in a separate Reference Project.
Refer to that repository's README for detailed verification procedures and contribution guidelines.
---
3. `Project_options.py` (Layout, Profile, Projections)
Use this after selecting the sync root.
- View Storage: Choose default
project-view/, root-view, or an explicit custom view root. - View Root Lock: Choose the view storage before the first export. After
.dump/manifest.jsonhas been created,Project_options.pylocks the layout and custom view root controls. To use a different export folder, start again with a clean sync directory. - Profile: Select the active CODESYS profile for object type handling.
- Projections: Enable optional readable files such as
.stand.csvbased on the active profile. - Safety Backup: Enable or disable timestamped binary backup before import and set how many generated backups to keep.
- Completion Summary: Show or hide the final import/export success popup.
- Git Ignore Helper: Append recommended generated-state ignore rules without rewriting existing user rules.
8. Optional Projections
Projections are editable views generated from XML-backed CODESYS objects. They are optional and selected in Project_options.py.
- POU
.st: Declaration/interface first, then// --- implementation ---, then implementation. - POU children
.st: Methods, actions, properties, and accessors are emitted as flat sibling files such asST_FB.ST_METHOD.st. - GVL, persistent variables, and DUT
.st: Global variables, persistent variable lists, task-local GVLs, and DUT declarations can be edited as text files. - TypeGuid metadata pragmas: Ambiguous
.stprojections may start with(* cds-text-sync: TypeGuid="{...}" *); this is a sync hint only and is stripped before XML rehydration or IDE text updates. - Text list
.csv: ExistingTextIDrows and language values can be edited for translation workflows. - Alarm item
.csv: Existing alarm rows can be edited by stableAlarmID. - Conflict Handling: If both the redacted XML and its projection changed, compare/import fails explicitly instead of choosing a source silently.
CSV projections are update-only in this release. Inserted, removed, renamed, or duplicate rows fail explicitly. CODESYS supports only one Persistent Variables object per application, so creating a second one from a new .st file is rejected before IDE apply. Graphical implementations are skipped by profile safety rules unless a safe textual representation is available.
⚡ External Editing & Sync (The "Developer" Workflow)
- Goal: Review and edit CODESYS projects with normal Git tools, external editors, and AI assistants.
- Method:
Project_export.pywrites generated snapshots to.dump/and editable files to the configured view root, usuallyproject-view/. - Benefit: XML remains the canonical round-trip format, while optional
.stand.csvprojections make code and translations readable in normal PR diffs.
For Zed users, PLC Structured Text provides IEC 61131-3 Structured Text syntax highlighting for the generated .st / .iecst projections, focused on CODESYS-style PLC projects.
---
🧠 Recommended Workflow with Git LFS
1. Configure: Run Project_directory.py and point the project at the intended sync folder. - Run Project_options.py to choose the layout, profile, and optional projections such as .st. - Use the .gitignore option there to append the recommended generated-state ignore rules. 2. Extract: Run Project_export.py. - The IDE snapshot goes to .dump/IDE.xml. - The reviewable export goes to the configured view root (project-view/ by default). 3. Commit: - git add . - git commit -m "Update logic" - Git tracks the view root and ignores generated state. - Git LFS may track binary backups if your team intentionally stores them. 4. Edit: Make changes in VS Code or CODESYS. 5. Sync: Run Project_import.py, Project_export.py, Project_compare.py, or Project_compare_ui.py depending on direction and whether you need a report or an IDE dialog. - Project_import.py applies disk changes back into the IDE. - Project_compare.py refreshes IDE.current.xml and writes a compare report. - Project_compare_ui.py shows the compare result and can launch full import/export.
6. `Project_compare.py` (IDE vs Disk)
Produces a report of differences between the current IDE state and the exported disk view.
- Fresh Compare Snapshot: Exports the current IDE state to
.dump/IDE.current.xml. - View Baseline: Compares that snapshot against the configured view root using the external diff engine.
- Report Output: Writes
.dump/compare_report.jsonfor diagnostics and follow-up review.
7. `Project_compare_ui.py` (Interactive IDE Compare)
- Same Baseline: Uses the same
.dump/IDE.current.xmlvs configured view root compare asProject_compare.py. - Object List: Adds object names and paths to
.dump/compare_report.jsonand shows them in a CODESYS dialog. - Actions: Can launch import or export from the dialog. Checked objects can be applied selectively when the external engine can resolve them by GUID.
该项目提供了一个开源的AI工作流，用于CODESYS文本同步，导出项目到ST文件，提高开发效率。代码清晰，注释充足，易于理解和使用。
- 可视化 Agent 工作流编排，无需编写复杂代码
- 支持多步骤自动化任务链，实现全流程无人值守
- 与外部 API、数据库和第三方服务无缝集成
- 内置错误处理与自动重试机制，保障稳定运行
- 提供可复用的自动化模板，快速在同类场景部署
- 自动化日常重复性工作，将精力集中于创造性任务
- 构建数据采集 → 处理 → 输出的完整自动化管线
- 实现跨平台、跨系统的数据流转和业务协同
- +MIT 协议，可免费商用
- +大幅减少重复性人工操作
- +可视化流程，清晰直观
- +可扩展性强，支持复杂场景
- −初始配置和调试需投入一定时间
- −强依赖外部服务的稳定性
- −复杂场景需具备一定技术基础
AI Skill Hub 为第三方内容聚合平台，本页面信息基于公开数据整理，不对工具功能和质量作任何法律背书。
建议在沙箱或测试环境中充分验证后，再部署至生产环境，并做好必要的安全评估。
✅ MIT 协议 — 最宽松的开源协议之一，可自由商用、修改、分发，仅需保留版权声明。
总体来看，CODESYS文本同步 是一款质量良好的Agent工作流，在同类工具中具备一定竞争力。AI Skill Hub 将持续追踪其更新动态，建议收藏备用，结合自身场景选择合适时机引入使用。
| 原始名称 | cds-text-sync |
| Topics | workflowautomationcodesysdevopsgitiec61131-3python |
| GitHub | https://github.com/ArthurkaX/cds-text-sync |
| License | MIT |
| 语言 | Python |
收录时间：2026-05-23 · 更新时间：2026-05-23 · License：MIT · AI Skill Hub 不对第三方内容的准确性作法律背书。