Agent skill

Modly CLI

by lightningpixel in lightningpixel/modly

Lets an agent call a running Modly desktop app from the terminal to generate image-to-3D assets and export meshes through JSON-first commands.

MITAuto-check passedMedia & Creative

Install Modly CLI

skills CLI
$ npx skills add lightningpixel/modly --skill modly-cli -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install lightningpixel/modly modly-cli --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/lightningpixel/modly.git skills-src && mkdir -p .claude/skills && cp -r skills-src/tools/modly-cli .claude/skills/modly-cli && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
modly-cli
GitHub stars
7.9k
Token cost
~1.7k tokens
SKILL.md length
545 words
Files
3
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Lets an agent call a running Modly desktop app from the terminal to generate image-to-3D assets and export meshes through JSON-first commands.

  • Generating a 3D model from an image through Modly
  • SKILL.md covers Overview, Prerequisites, Canonical Commands and Model Selection, plus 6 more sections
  • Runs Python scripts from its folder; calls python
  • Exporting a finished mesh from a Modly workspace

What it does

The skill wraps a small standard-library Python script, tools/modly-cli/agent.py, that talks to the local API Modly exposes while the official desktop app is running. Its canonical commands are health, model, workflow-run, capability and process-run, plus a generate wrapper. Final JSON goes to stdout, progress lines go to stderr, and a compact flag prints single-line JSON for other agents.

The agent launches Modly first and checks readiness with the health command, which returns structured errors such as API_UNAVAILABLE when the app cannot be reached. It can list models and parameters, start, check and cancel workflow runs, or generate from an image and export the finished mesh, for example as a .glb file, with a no-export option that returns only the workspace path. Capability and process-run commands work only when the running server exposes that contract, and otherwise they fail closed with UNSUPPORTED_PROCESS.

When your agent uses it

  • Generating a 3D model from an image through Modly
  • Exporting a finished mesh from a Modly workspace
  • Checking Modly's models and workflow run status from a script or an agent

Example prompts

  • “Generate a 3D model from ./input.png with Modly and export it as ./export.glb.”
  • “Check whether the Modly desktop app is running and which model is active.”
  • “Cancel the Modly workflow run I started a minute ago.”

Requirements

  • The Modly desktop app, running
  • Python

What it can do on your machine

Read from SKILL.md and the folder at commit f11a4d2. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • python

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Modly CLI loads about 1.7k tokens when it runs. Until then it costs about 45 tokens; SKILL.md has 545 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~45
When it runs · the whole SKILL.md, loaded when a task matches
~1.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from lightningpixel/modly at commit f11a4d2, republished under its MIT licence (© lightningpixel). 545 words, ~1,739 tokens.

Download SKILL.mdSave it as .claude/skills/modly-cli/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
modly-cli
description
Use when an agent needs to call a running Modly desktop instance from the terminal to generate/export image-to-3D assets through canonical JSON-first automation commands.
version
1.2.0
author
Modly
license
MIT

Modly CLI

Overview

Modly exposes a local API at http://127.0.0.1:8765 while the official desktop app is running. The stdlib-only CLI at tools/modly-cli/agent.py is an agent helper over the canonical automation contract:

  • health
  • model
  • workflow-run
  • capability
  • process-run

Final machine-readable JSON is printed to stdout. Progress JSON lines, when requested, are printed to stderr.

Prerequisites

Launch the official Modly desktop app first, then check readiness:

bash
python tools/modly-cli/agent.py health

Use --compact when another agent needs single-line JSON:

bash
python tools/modly-cli/agent.py --compact health

GET /health is checked before business operations. If the app is unavailable, failures are structured:

json
{
  "ok": false,
  "code": "API_UNAVAILABLE",
  "message": "Cannot reach Modly API at ..."
}

Canonical Commands

Inspect models through /model/*:

bash
python tools/modly-cli/agent.py model list
python tools/modly-cli/agent.py model status
python tools/modly-cli/agent.py model params --model active

Start or resume workflow runs:

bash
python tools/modly-cli/agent.py workflow-run start --image ./input.png --wait
python tools/modly-cli/agent.py workflow-run status <run_id>
python tools/modly-cli/agent.py workflow-run cancel <run_id>

Generate from an image and export the finished mesh:

bash
python tools/modly-cli/agent.py generate \
  --image ./input.png \
  --output ./export.glb \
  --progress

generate is a friendly wrapper around POST /workflow-runs/from-image and GET /workflow-runs/{run_id}. It does not silently fall back to /generate/*. The JSON includes recovery metadata:

json
{
  "ok": true,
  "run": {"kind": "workflowRun", "id": "..."},
  "workspace_path": "Default/model.glb",
  "export_path": "/absolute/path/to/export.glb",
  "meta": {
    "status_command": "python tools/modly-cli/agent.py workflow-run status ...",
    "cancel_command": "python tools/modly-cli/agent.py workflow-run cancel ...",
    "legacy": false
  }
}

Use --no-export when the caller only needs the workspace path. The hidden export helper remains available to download an existing workspace mesh, but it is not part of the canonical root command set:

bash
python tools/modly-cli/agent.py export --path Default/model.glb --output ./model.glb

Discover capabilities or process runs only when the running server exposes the canonical contract:

bash
python tools/modly-cli/agent.py capability list
python tools/modly-cli/agent.py process-run status <run_id>

If the contract is absent, the CLI fails closed:

json
{
  "ok": false,
  "code": "UNSUPPORTED_PROCESS",
  "message": "This process is not available through the canonical process-run contract."
}

Model Selection

--model auto uses the active model reported by /model/status, then validates that id against /model/all. Explicit --model values are also validated against /model/all. The CLI does not infer hidden capabilities from model names, labels, or string fragments.

Legacy Compatibility

The old /generate/* endpoints are explicit compatibility commands:

bash
python tools/modly-cli/agent.py legacy job <job_id>
python tools/modly-cli/agent.py legacy cancel <job_id>
python tools/modly-cli/agent.py legacy generate --image ./input.png --output ./legacy.glb

Legacy responses include meta.legacy: true. Top-level job, cancel, models, and params aliases may still parse for older scripts, but they are not the documented canonical surface.

Developer-Only API Helpers

Headless startup helpers live under dev:

bash
python tools/modly-cli/agent.py dev serve-api --print-command
python tools/modly-cli/agent.py dev ensure-server
python tools/modly-cli/agent.py dev ensure-server --start --detach

These commands start or inspect only the FastAPI backend. They do not imply Electron/Desktop bridge readiness, scene operation readiness, extension process execution readiness, or full workflow support. Prefer launching the official desktop app for real agent workflows.

Show full SKILL.md (238 more words)Show less

Experimental ComfyUI Helpers

ComfyUI orchestration is outside the canonical Modly contract and lives under experimental:

bash
python tools/modly-cli/agent.py experimental comfy-image \
  --workflow Trellis2Workflow \
  --prompt "clean object render, isolated on white" \
  --comfy-output ./source.png

python tools/modly-cli/agent.py experimental generate-from-workflow \
  --workflow Trellis2-Full \
  --prompt "clean orthographic product render of a stylized robot toy" \
  --output ./export.glb

experimental generate-from-workflow --workflow <name> --output <path> treats --output as the final artifact location. If the ComfyUI history contains a downloadable .glb, .gltf, .obj, .stl, or .ply, the CLI downloads that asset directly and does not call Modly health or generation. If the workflow only produces an image, the CLI downloads that image and falls back through the canonical Modly workflow-run generation path. If no supported asset or image is found, it fails with code: "NO_WORKFLOW_OUTPUT".

Hidden Helper Aliases

The top-level status, export, and batch helpers remain parseable for older scripts and agent ergonomics, but root help does not present them as canonical automation primitives. Prefer health, model, workflow-run, capability, and process-run when documenting the supported contract.

Batch Workflow

The hidden batch helper generates meshes sequentially from a directory or manifest JSON through the canonical generate path:

bash
python tools/modly-cli/agent.py batch \
  --input-dir ./images \
  --output-dir ./meshes \
  --continue-on-error

python tools/modly-cli/agent.py batch \
  --manifest ./jobs.json \
  --output-dir ./meshes

Manifest files may be a JSON list, or an object with jobs or images. Each entry can be a string image path or an object with image, optional output, and optional format.

Verification Checklist

  • python tools/modly-cli/agent.py health returns ok: true.
  • python tools/modly-cli/agent.py model list returns model entries.
  • python tools/modly-cli/agent.py generate --image <image> --output <mesh> returns ok: true, run.kind: workflowRun, and recovery metadata.
  • The reported export_path exists and has non-zero size when export is enabled.
  • python tools/modly-cli/agent.py workflow-run status <run_id> can resume polling from metadata.
  • python tools/modly-cli/test_agent.py passes.

© lightningpixel, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files in tools/modly-cli of lightningpixel/modly.

  • SKILL.md
  • agent.py
  • test_agent.py

Open the folder on GitHubat commit f11a4d2

Compare with similar skills

Modly CLI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Modly CLI compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Modly CLI this skilllightningpixel/modly7.9k—~1.7kAutomated safety check: PassMIT
Kinetic Reeltuzhechen2005/opus-video-skills121—~1.8kAutomated safety check: PassCustom licence
P5jsTommy-yw/RunbookHermes5461 repos~6.8kAutomated safety check: PassMIT
Video LessonsRemocn/remocn-studio149—~689Automated safety check: PassMIT
Disney Animation Rule Skillvibe-motion/skills1.3k—~1.5kAutomated safety check: PassNone
Image to Three.js Modelimg2threejs/img2threejs18k1 repos~8.2kAutomated safety check: PassApache-2.0

Similar skills

  • Kinetic Reel

    tuzhechen2005/opus-video-skills

    Make kinetic-typography motion reels (MP4) in code: showreels, portfolio or work reels, product promos, intro films, "motion design"-style videos with bold condensed type, HUD micro-type…

    121 GitHub stars~1.8k tokensUpdated 10 days ago
    Media & CreativeAuto-check passed
  • P5js

    Tommy-yw/RunbookHermes

    Production pipeline for interactive and generative visual art using p5.js.

    546 GitHub starsUsed in 1 repo~6.8k tokens
    Media & CreativeAuto-check passed
  • Video Lessons

    Remocn/remocn-studio

    Diagnose Remotion implementation and render defects: font fallback, text jitter, local-frame timing, transition seams, wall-clock CSS, WebGL output and export reproducibility.

    149 GitHub stars~689 tokensUpdated yesterday
    Media & CreativeAuto-check passed
  • Disney Animation Rule Skill

    vibe-motion/skills

    Apply Disney's 12 principles as practical design and engineering rules for procedural animation.

    1.3k GitHub stars~1.5k tokensUpdated 2 days ago
    Media & CreativeAuto-check passed
  • Image to Three.js Model

    img2threejs/img2threejs

    Rebuilds the object in a reference image as a procedural, animation-ready Three.js model written entirely in code, using staged sculpting with quality checks.

    18k GitHub starsUsed in 1 repo~8.2k tokens
    Game DevelopmentAuto-check passed
  • Generates game art from text prompts: PNG images, GLB 3D models, rigged characters, animations and sprites, with background removal.

    7.1k GitHub stars~2.8k tokensUpdated 6 days ago
    Game DevelopmentAuto-check passed

Questions about Modly CLI

What does Modly CLI do?

Lets an agent call a running Modly desktop app from the terminal to generate image-to-3D assets and export meshes through JSON-first commands. py, that talks to the local API Modly exposes while the official desktop app is running. Its canonical commands are health, model, workflow-run, capability and process-run, plus a generate wrapper.

When should I use Modly CLI?

Modly CLI fits situations like: generating a 3D model from an image through Modly; exporting a finished mesh from a Modly workspace; checking Modly's models and workflow run status from a script or an agent.

How do I install Modly CLI in Claude Code?

Run `npx skills add lightningpixel/modly --skill modly-cli -a claude-code`. Or copy the skill folder (tools/modly-cli in lightningpixel/modly) into .claude/skills/modly-cli in your project. Claude Code loads it when a task matches its description.

How do I install Modly CLI in Codex?

Run `npx skills add lightningpixel/modly --skill modly-cli -a codex`. Or copy the skill folder (tools/modly-cli in lightningpixel/modly) into .agents/skills/modly-cli in your project. Codex loads it when a task matches its description.

Can I use Modly CLI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add lightningpixel/modly --skill modly-cli -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/modly-cli, .gemini/skills/modly-cli, .github/skills/modly-cli and .opencode/skills/modly-cli in your project.

What does Modly CLI need to run?

Going by SKILL.md and its folder, Modly CLI needs Python for the scripts in its folder and the command-line tools its instructions call (python). Our summary lists: The Modly desktop app, running; Python.

Does Modly CLI access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Modly CLI safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Modly CLI use?

Modly CLI is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Modly CLI use?

About 1.7k tokens (SKILL.md is roughly 7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Modly CLI?

Skills that share tags, products or a category with Modly CLI: Kinetic Reel (tuzhechen2005/opus-video-skills, 121 stars), P5js (Tommy-yw/RunbookHermes, 546 stars), Video Lessons (Remocn/remocn-studio, 149 stars) and Disney Animation Rule Skill (vibe-motion/skills, 1.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Modly CLI?

lightningpixel (a GitHub user) maintains it in lightningpixel/modly, which has 7,949 GitHub stars. The repository was last updated on October 4, 2026.

Source: lightningpixel/modly on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.