sysmlv2copilot

sysmlv2copilot is the Python SDK and CLI for the SysML Copilot service used by the Visual Design and Engineering Lab at Carnegie Mellon University.

This package is for authorized internal users. Installing it does not by itself grant service access.

What Users Can Do

• Generate SysML from text requirements
• Repair existing SysML
• Use either Python or the command line

Install

python -m pip install sysmlv2copilot

Upgrade an existing install:

python -m pip install -U sysmlv2copilot

Authentication

Set your API key once:

export SYSMLV2COPILOT_API_KEY=sysml_live_...

Or pass it directly in code:

from sysmlv2copilot import generate, repair

sysml = generate(
    "Design a compact warehouse inspection drone that can hover for 15 minutes.",
    api_key="sysml_live_...",
)

repaired = repair(
    "broken.sysml",
    api_key="sysml_live_...",
)

Python

Generate SysML:

from sysmlv2copilot import generate

sysml = generate("Design a compact warehouse inspection drone that can hover for 15 minutes.")
print(sysml)

Repair SysML:

from pathlib import Path

from sysmlv2copilot import repair

repaired = repair(Path("broken.sysml"))
print(repaired)

If a .txt file contains SysML, repair() can use that too:

from pathlib import Path

from sysmlv2copilot import repair

repaired = repair(Path("broken.txt"))
print(repaired)

You can pass:

• raw strings
• Path objects
• path strings like "broken.sysml" or "requirements.html"
• open text files

Use generate() for natural-language requirements and repair() for SysML, regardless of whether the file extension is .sysml or .txt.

CLI

Generate SysML from inline text:

sysmlv2copilot --api-key sysml_live_... \
  generate \
  --input "Design a compact warehouse inspection drone that can hover for 15 minutes."

Repair SysML from a file:

sysmlv2copilot --api-key sysml_live_... \
  repair \
  --input-file ./broken.sysml

The CLI accepts .txt, .sysml, and .html files for --input-file. HTML files are converted to plain text before being sent to the API.