Skip to content

CLI for AI Agents (Beta) ​

Use CLI for AI Agents (Beta) to connect an external AI agent to D5 Lite, inspect a scene, and plan and run supported changes. D5 Render's built-in AI Agent is a separate feature.

D5 Lite includes the Windows connector D5LiteWorkflowCli.exe. Check the help provided by the connector from your current installation before asking the agent to run a task. The available operations depend on the Lite version, the modeling software, and the running session. Modeling operations are available only in SketchUp. In Rhino and Revit, the CLI works with D5 Lite, not the host model.

1. Before You Begin ​

  1. Install D5 Lite for SketchUp, Rhino, or Revit through the D5 Launcher. Run the agent on that Windows computer while signed in to the Windows account that installed Lite.
  2. The installation includes the d5lite-ops-author skill for authoring workflows. If your agent looks for skills only in its own skills folder, copy the included skill folder there once.
  3. The default local environment check works with your modeling software closed. To check the live connection to your current project or work with its Lite scene, open the project in your modeling software and start D5 Lite.

Send this prompt to your agent:

text
Find the D5 Lite connector (D5LiteWorkflowCli.exe) for my current modeling software and installation.
Report the connector path and version, the local environment check result, and the result of a separate read-only connection check to my running modeling software. Explain any failure and how I can retry.

A passing local environment check means the connector and local workflow environment are available. To work with the open project, also check that the live host connection is ready. If the local check passes but the host is not ready, open the project, start Lite, and ask the agent to check the live connection again.

3. If Automatic Discovery Fails: Specify the File Manually ​

Ask the agent to look up the recorded Lite installation folder for your modeling software. Find D5LiteWorkflowCli.exe in that folder and give the agent its full path. If there are several copies, use the one from your current Lite installation. Ask the agent to report the connector version and rerun both the local and live connection checks. Rerun both checks if the installation location changes.

4. Completing Your First Connection ​

Start with a read-only task:

text
Read the active D5 Lite scene without making any changes. Tell me which modeling software and scene you reached, then list the scene settings you can read or change with this version.

Check that the reported scene matches the one you have open. If the agent can't read the scene, check the live connection before trying a change.

For a change to a scene, material, light, camera, or project file:

  1. Ask the agent to validate the workflow and show the execution plan, including what it will change.
  2. Review and confirm that plan before it runs. If the workflow or the connector's requirements change, review and confirm a new plan.
  3. After the agent runs the plan, ask it to read back the affected state and report the result. Check the result in the corresponding scene or file. If execution stops and you can't tell what changed, check the current state before retrying.

5. FAQ ​

1. The agent reports that D5 Lite cannot be found ​

Confirm that D5 Lite is installed for your modeling software and that the agent is running on the same Windows computer, signed in to the account that installed Lite. If automatic discovery still fails, specify the connector file manually.

2. The file is found, but the environment check fails ​

Check that the connector came from your current Lite installation. If the file matches and the check still fails, reinstall the matching Lite plugin through the D5 Launcher and try again.

3. The environment check passes, but the modeling software cannot be controlled ​

The local check only verifies the connector and the local workflow environment. The live check verifies its connection to the running modeling software. Open the project in your modeling software, start Lite, and wait for it to load. If there are duplicate Lite or modeling software windows, close the duplicates and retry the live connection check. If the host is ready but a task is unavailable, check the connector's supported operations for your version.

4. Several files with the same name are found ​

Use the D5LiteWorkflowCli.exe from the installation for the modeling software and Lite version you are using. Follow the manual selection steps above and run both checks.

D5 Help Center