# ecutest-api-skill

> Local ecu.test 2024.3 knowledge base (RST-first). Use local RST sources (_sources) + ApiClient scripts/templates for accurate API answers and Python code generation.

- Author: LEO\leo
- Repository: Blitzer207/ecutest-api-skill
- Version: 20260126123452
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/Blitzer207/ecutest-api-skill
- Web: https://mule.run/skillshub/@@Blitzer207/ecutest-api-skill~ecutest-api-skill:20260126123452

---

---
name: ecutest-api-skill
description: Local ecu.test 2024.3 knowledge base (RST-first). Use local RST sources (_sources) + ApiClient scripts/templates for accurate API answers and Python code generation.
---

# ecu.test 2024.3 (local, RST-first)

Use local ecu.test 2024.3 files as the source of truth. Prefer RST (`*_sources/*.rst.txt`) over HTML when extracting API details; use Python templates for exact signatures and practical usage.

## Base path / environment
- `ECU_TEST_HOME` is loaded from environment or from `.env` next to this file (skill repo root).
- Default (if unset): `C:\Program Files\ecu.test 2024.3\`

## Modules (RST roots + example code)
All paths below are relative to `%ECU_TEST_HOME%` (default: `C:\Program Files\ecu.test 2024.3\`).

### general_api (APIDoc / Object API + Internal API)
- RST root: `Help\APIDoc\_sources\general_api\`
- Key RST:
  - `Help\APIDoc\_sources\general_api\api.rst.txt` (Internal API entry point: `Api()`)
  - `Help\APIDoc\_sources\general_api\objectApi.rst.txt` (Object API entry point + `ApiClient`)
  - `Help\APIDoc\_sources\general_api\objectApiExamples.rst.txt` (Object API code examples)
- Python interface (exact signatures):
  - `Templates\ApiClient\ObjectApiProxy.py`
  - `Templates\ApiClient\ApiClient.py`
  - `Templates\ApiClient\ApiClient.xml`

### user_utility (APIDoc / UserTool + utilities)
- RST root: `Help\APIDoc\_sources\user-utility\`
- Python examples:
  - `Help\APIDoc\ExampleUtilities\`
  - `Templates\DefaultData\Utilities\`

### tools (APIDoc / tooling framework)
- RST root: `Help\APIDoc\_sources\tools\`

### generators (APIDoc / generators)
- RST root: `Help\APIDoc\_sources\generators\`
- Python examples:
  - `Templates\DefaultData\ProjectGenerators\`

### traceanalysis_api (TraceanalysisAPI)
- RST root: `Help\APIDoc\TraceanalysisAPI\_sources\`
  - Note: prefer this folder over `Help\APIDoc\_sources\TraceanalysisAPI\`
- Python examples:
  - `Templates\DefaultData\TraceStepTemplates\ExampleTraceStepTemplates\`

### trace_step_templates_doc (TraceStepTemplatesDoc)
- RST index: `Help\TraceStepTemplatesDoc\_sources\index.rst.txt`
- RST root: `Help\TraceStepTemplatesDoc\_sources\root\`
- Python examples:
  - `Templates\DefaultData\TraceStepTemplates\ExampleTraceStepTemplates\`

### Extra example locations
- UserPyModules examples:
  - `Templates\DefaultData\UserPyModules\`

## Source of truth (in order)
1) RST sources (`*.rst.txt`) for the relevant module (see Modules section above).
2) Python API interface definitions (exact signatures win):
   - `Templates\ApiClient\ObjectApiProxy.py`
   - `Templates\ApiClient\ApiClient.py`
   - `Templates\ApiClient\ApiClient.xml`
3) Python examples (real usage patterns; prefer these over guessing).

## Local experience / standards (must follow when writing code)
- `references\coding-standards.md` (includes API entry points + hard-won safety rules)

## Fast lookup workflow
1) Pick the right doc base (by module).
2) Use the Sphinx index search helper (outputs RST paths by default):
   - `python scripts/search_api.py --query AnalysisJobApi`
   - `python scripts/search_api.py --base "<ECU_TEST_HOME>\Help\APIDoc\TraceanalysisAPI" --query TraceAnalysis`
   - `python scripts/search_api.py --base "<ECU_TEST_HOME>\Help\TraceStepTemplatesDoc" --query Numpy`
3) Use ripgrep for exact matches inside RST/templates:
   - `rg -n "<keyword>" "<ECU_TEST_HOME>\Help\APIDoc\_sources" -g "*.rst.txt"`
   - `rg -n "<keyword>" "<ECU_TEST_HOME>\Help\APIDoc\TraceanalysisAPI\_sources" -g "*.rst.txt"`
   - `rg -n "<keyword>" "<ECU_TEST_HOME>\Help\TraceStepTemplatesDoc\_sources" -g "*.rst.txt"`
   - `rg -n "class .*Api" "<ECU_TEST_HOME>\Templates\ApiClient\ApiClient.py"`
4) When generating Python code, confirm names/parameters in `ApiClient.py` / `ApiClient.xml` (these win over prose).

## Answering rules (keep replies accurate)
- Do not rely on HTML pages unless you need navigation or images; extract facts from the RST sources.
- Always cite the local file paths you used (RST and/or Python source files).