Files
TARE-Learn/deliverables/客户AI工程Skill交付包/skills/project-knowledge-builder/references/compatibility.md
T
smart 67837df8d0 docs: 更新TRA编程培训课程材料、课件与AI技能交付包
- 新增全套考试卷、评估卷、参考答案与考试培训包模板
- 修正slidev培训课件:调整模块标题、链路图缩放,替换工单示例为通用业务对象
- 修正课堂红线表述为证据红线,将小组作业调整为个人作业要求
- 新增权限、状态流转、审计日志、看板指标四类可复用业务规则块
- 整理AI工程技能交付包,迁移旧资产至客户专属交付包并统一术语
- 新增考试输出模板与TRAE使用记录文档
2026-08-08 11:00:36 +08:00

3.3 KiB

Cross-Platform Compatibility

Use this reference when running or installing the skill on macOS, Windows, Linux, or CI.

Compatibility Summary

Area macOS Linux Windows
SKILL.md workflow Supported Supported Supported
project_inventory.py Supported with Python 3.9+ Supported with Python 3.9+ Supported with Python 3.9+
Python dependencies Standard library only Standard library only Standard library only
Path handling pathlib pathlib pathlib
Shell dependency None in script None in script None in script
Generated Markdown paths POSIX-style relative paths POSIX-style relative paths POSIX-style relative paths

The script intentionally emits repository-relative paths with / separators so generated Markdown is stable across platforms and friendlier for URLs, GitHub, and RAG metadata.

Python Invocation

macOS and Linux usually have one of these:

python3 skills/project-knowledge-builder/scripts/project_inventory.py --root . --out docs/project-knowledge/generated
python skills/project-knowledge-builder/scripts/project_inventory.py --root . --out docs/project-knowledge/generated

Windows PowerShell usually uses:

py -3 skills\project-knowledge-builder\scripts\project_inventory.py --root . --out docs\project-knowledge\generated
python skills\project-knowledge-builder\scripts\project_inventory.py --root . --out docs\project-knowledge\generated

CI should prefer an explicit Python:

python -m py_compile skills/project-knowledge-builder/scripts/project_inventory.py
python skills/project-knowledge-builder/scripts/project_inventory.py --root . --out docs/project-knowledge/generated --json

Command Substitutions

Task macOS/Linux Windows PowerShell
List docs find docs/project-knowledge -type f | sort Get-ChildItem docs/project-knowledge -Recurse -File | Sort-Object FullName
Search placeholders `rg -n "TODO TBD" docs/project-knowledge`
Show git status git status --short git status --short
Remove temp output rm -rf ./kb-inventory Remove-Item .\kb-inventory -Recurse -Force

rg is preferred where available. If rg is not installed, use the platform search available in the environment.

Avoid In Skill Examples

  • Hard-coded /tmp paths when the command should work on Windows.
  • POSIX-only command chains such as cmd1 && cmd2 in user-facing instructions when a PowerShell equivalent is needed.
  • Shell glob assumptions that behave differently between zsh, bash, PowerShell, and cmd.
  • Python code that depends on executable shebang behavior; Windows users should call py -3 script.py.

Known Limits

  • Java endpoint extraction is regex-based and intentionally conservative. It does not fully resolve constants, composed annotations, or inherited controller mappings.
  • SQL table extraction looks for CREATE TABLE; tables created dynamically or through migrations in another DSL need manual documentation.
  • Frontend route extraction scans route-like literals and view files; runtime-generated route data from APIs still requires backend menu/permission data or database export.
  • Very large repositories may need --max-files tuning or additional ignore directories.