Skip to content

feat: add agent-friendly Modly CLI #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jokrasno wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat: add agent-friendly Modly CLI #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ api/*.pyc
api/**/*.pyc
api/.venv/
api/venv/
tools/modly-cli/__pycache__/

# Models (heavy, downloaded at runtime)
/models/
Expand Down
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Alternatively, you can clone the repository and run the app directly without ins

```bash
# Windows
launcher.bat
launch.bat

# Linux
./launcher.sh
Expand Down Expand Up @@ -91,7 +91,22 @@ Modly supports external AI model extensions. Each extension is a GitHub reposito

---

### Community
## Modly CLI

Agents and scripts can call a running Modly desktop app without using the UI via the stdlib-only CLI:

```bash
python tools/modly-cli/agent.py health
python tools/modly-cli/agent.py generate --image ./input.png --output ./export.glb
python tools/modly-cli/agent.py generate-from-workflow --workflow Trellis2Workflow --prompt "clean isolated robot toy" --output ./export.glb
python tools/modly-cli/agent.py generate --image ./input.png --output ./fast-geometry.glb --no-texture
```

Useful extras include `status`, `models`, `params`, `job`, `cancel`, `export`, directory/manifest `batch`, preconfigured ComfyUI source-image runs via `comfy-image` / `generate-from-workflow` (default workflow name: `Trellis2Workflow`), and optional headless backend startup with `serve` / `ensure-server --start`. The CLI talks to the local app API at `http://127.0.0.1:8765`, runs the texture/refine node by default when one is available, waits for image-to-3D generation, exports the mesh, and prints a single JSON object containing the new `export_path`. Agent texture defaults are intentionally higher quality than the extension UI defaults (`texture_steps=30`, `texture_guidance=3.0`); override them with flags if needed. Use `--no-texture` only for faster geometry-only smoke tests. See `tools/modly-cli/SKILL.md` for the agent workflow and output contract.

---

### Community

Join the [Discord server](https://discord.gg/BvjDCvS3yr) to stay up to date with the latest news, report bugs, and share feedback.

Expand Down
Loading