Meshy CLI
अपने टर्मिनल से Meshy मॉडल जनरेट, ट्रैक, और डाउनलोड करें। एक कमांड किसी prompt या इमेज को टेक्सचर्ड मॉडल में बदल देता है, और अधिकांश API एंडपॉइंट अपने आप में कमांड होते हैं।
Meshy CLI (meshy) उसी REST API को उन्हीं कीमतों पर कॉल करता है जिन्हें बाकी के ये दस्तावेज़ उपयोग करते हैं। आप अपने ब्राउज़र में एक बार साइन इन करते हैं, इसलिए आपको API की की आवश्यकता नहीं है। टर्मिनल में यह एक पठनीय व्यू प्रिंट करता है, और स्क्रिप्ट, पाइप, CI, या AI एजेंट में यह JSON प्रिंट करता है।
क्या आप किसी ऐसे चैट ऐप का उपयोग कर रहे हैं जो MCP के ज़रिए टूल्स से कनेक्ट होता है, जैसे Claude Desktop? CLI और MCP server के बीच चुनाव करने के लिए AI इंटीग्रेशन देखें।
इंस्टॉल करें
CLI को Node.js 22.12 या उसके बाद के संस्करण की आवश्यकता होती है। यह macOS, Linux, और Windows पर चलता है।
Install
npm install -g meshy-cli
meshy doctor # checks your environment, without calling the API
यह पैकेज दो कमांड इंस्टॉल करता है, meshy और meshy-cli। वही बिल्ड @meshy-ai/cli के रूप में भी प्रकाशित किया गया है। इन दोनों में से केवल एक ही पैकेज इंस्टॉल करें, क्योंकि दोनों meshy कमांड प्रदान करते हैं और npm दूसरे को EEXIST के साथ अस्वीकार कर देता है।
CLI ओपन सोर्स है। इसका सोर्स GitHub पर meshy-cli repository में है।
साइन इन करें
Sign in
meshy auth login # opens your browser
meshy auth status # shows which account and credential are in use
meshy auth login आपके ब्राउज़र में Meshy साइन-इन पेज खोलता है और आपके कंप्यूटर पर क्रेडेंशियल सहेजता है। यदि ब्राउज़र नहीं खुलता है, तो CLI द्वारा प्रिंट किए गए URL को कॉपी करें।
रिमोट मशीनें, SSH और कंटेनर
बिना ब्राउज़र वाली मशीन पर, meshy auth login इसके बजाय एक लिंक और एक छोटा कोड प्रिंट करता है। किसी भी डिवाइस पर, जैसे कि आपके लैपटॉप या फोन पर, लिंक खोलें, साइन इन करें, और कोड दर्ज करें। CLI स्वयं साइन-इन पूरा कर लेता है।
CLI इस फ़्लो को तब चुनता है जब वह SSH, एक कंटेनर, CI, बिना डिस्प्ले वाला Linux, या कोई इंटरैक्टिव टर्मिनल न होने का पता लगाता है, जैसे कि जब कोई AI एजेंट कमांड चलाता है। यह तब भी इसे चुनता है जब MESHY_CLI_NO_BROWSER सेट किया गया हो। इसे स्वयं चुनने के लिए, meshy auth login --device चलाएँ।
meshy auth login --device
API की और CI
CI और अन्य अनअटेंडेड जॉब्स के लिए, ब्राउज़र साइन-इन के बजाय एक API की का उपयोग करें। इसे MESHY_API_KEY एनवायरनमेंट वेरिएबल में सेट करें। यह संग्रहीत साइन-इन पर प्राथमिकता लेता है।
API key
export MESHY_API_KEY="msy_YOUR_API_KEY"
meshy balance
आप meshy auth login --with-key msy_YOUR_API_KEY के साथ भी एक की संग्रहीत कर सकते हैं।
CLI इस क्रम में सबसे पहले मिलने वाले क्रेडेंशियल का उपयोग करता है: --api-key, MESHY_API_KEY, --api-key-file, फिर संग्रहीत साइन-इन। यदि CLI आपकी अपेक्षा से भिन्न खाते का उपयोग करता है, तो यह देखने के लिए कि कौन सा क्रेडेंशियल प्रभाव में है, meshy auth status चलाएँ।
China site (चाइना साइट)
एक ही Meshy खाता दोनों साइट पर काम करता है। meshy.cn का उपयोग करने के लिए, meshy auth login --region cn से साइन इन करें। CLI आपके साइन-इन के साथ रीजन को सेव कर लेता है, इसलिए बाद के कमांड बिना किसी फ़्लैग के api.meshy.cn को कॉल करते हैं। वापस स्विच करने के लिए, --region global से साइन इन करें।
अपना पहला मॉडल बनाएं
meshy make पूरे फ़्लो को एक ही कमांड में चलाता है। एक टेक्स्ट prompt एक टेक्स्ट से 3D preview चलाता है और फिर एक refine करता है। एक इमेज एक टेक्स्चर्ड इमेज से 3D टास्क चलाती है।
सबसे पहले, बिना कोई क्रेडिट खर्च किए यह जांचें कि एक रन क्या करेगा और इसमें कितने क्रेडिट लगेंगे:
Dry run
meshy make "a lovely baby husky" --dry-run
फिर इसे चलाएं, और -o के साथ मॉडल को एक फ़ोल्डर में सेव करें:
Make a model
meshy make "a lovely baby husky" -o out/husky/
Output
✓ [1/2] text-to-3d preview (geometry) 01a0c94c-… 1m 27s
✓ [2/2] text-to-3d refine (textures) 01a0c94d-… 5m 36s
✓ SUCCEEDED text-to-3d-refine
Task 01a0c94d-eaba-710e-b5b7-da5b2f620c95
Created 2026-11-13 10:02
Took 7m 03s
Credits ~30 (estimate for the whole chain)
Assets glb, fbx · textures: base_color, metallic, normal, roughness · thumbnail
Saved out/husky/model.glb
out/husky/thumbnail.png
out/husky/meta.json
फ़ोल्डर में अब मॉडल, उसका थंबनेल, और एक meta.json फ़ाइल मौजूद है। इसके बजाय किसी फ़ोटो से शुरू करने के लिए, उसका पाथ या URL दें: meshy make ./cat.png -o out/cat/.
कमांड्स
ज़्यादातर API एंडपॉइंट अपने-आप में एक कमांड हैं, और हर task कमांड एक जैसी verbs लेता है: create, get, list, wait, stream, और delete। जिस एंडपॉइंट का अपना कमांड नहीं है, उसके लिए meshy api का उपयोग करें।
ये कमांड्स सामान्य tasks को कवर करते हैं:
Endpoint commands
meshy text-to-3d create --mode preview --prompt "a red sports car"
meshy image-to-3d create --image-url ./cat.png --async # returns the task ID at once
meshy image-to-3d wait <task-id> -o out/cat/
meshy text-to-3d list
meshy download --resource text-to-3d --task-id <task-id> --list
meshy balance
| कमांड | यह क्या करता है |
|---|---|
meshy make | पूरा prompt-to-model या image-to-model फ़्लो चलाता है |
meshy <resource> <verb> | एक एंडपॉइंट को कॉल करता है, जैसे meshy remesh create या meshy rigging get |
meshy download | पूरे हो चुके task की फ़ाइलों को लिस्ट या सेव करता है |
meshy balance | आपका क्रेडिट बैलेंस दिखाता है |
meshy api <METHOD> <path> | किसी भी एंडपॉइंट को सीधे कॉल करता है, जैसे meshy api GET /balance |
meshy resources | हर कमांड को लिस्ट करता है |
meshy auth | login, status, list, use, logout |
meshy doctor | आपके सेटअप की जाँच करता है |
किसी कमांड के फ्लैग्स के लिए, meshy <resource> --help चलाएँ। हर एंडपॉइंट के पैरामीटर्स और क्रेडिट लागत के लिए, इन डॉक्स में उसका पेज देखें, जैसे टेक्स्ट से 3D।
CLI में 3D प्रिंटिंग के लिए लोकल हेल्पर्स भी हैं, जैसे meshy inspect faces, meshy mesh prepare-print और meshy slicer। ये आपके कंप्यूटर पर चलते हैं और API को कॉल नहीं करते। हर कमांड के लिए Using meshy-cli देखें।
स्क्रिप्ट्स, एजेंट्स, और CI
JSON आउटपुट
जब इसका आउटपुट किसी पाइप, फ़ाइल, स्क्रिप्ट या AI एजेंट को जाता है, तो CLI JSON प्रिंट करता है। टर्मिनल में यह एक पठनीय व्यू प्रिंट करता है। हमेशा JSON प्राप्त करने के लिए --format json (या --json) पास करें।
हर कमांड stdout पर बिल्कुल एक JSON दस्तावेज़ प्रिंट करता है, जिसमें वही छह keys होती हैं। Progress और संदेश stderr पर जाते हैं।
Read the task ID
meshy text-to-3d create --mode preview --prompt "a cactus" --async --format json \
| jq -r .result.submission.task_id
Output shape
{
"schema_version": "meshy.cli/v1",
"command": "image-to-3d.get",
"ok": true,
"result": { "task": { "task_id": "…", "status": "IN_PROGRESS", "progress": 52 } },
"error": null,
"warnings": []
}
ok यह बताता है कि CLI कमांड काम किया या नहीं। टास्क की अपनी स्थिति result.task.status में होती है। उदाहरण के लिए, किसी FAILED टास्क पर get चलाने पर ok: true मिलता है, क्योंकि अनुरोध ने स्वयं काम किया था।
CLI हर create अनुरोध को एक बार भेजता है और इसे कभी खुद से फिर से कोशिश नहीं करता, इसलिए एक नेटवर्क त्रुटि दूसरा टास्क नहीं बना सकती और उसके लिए शुल्क नहीं ले सकती।
एग्ज़िट कोड
एग्ज़िट कोड स्क्रिप्ट को बताता है कि क्या हुआ:
| कोड | अर्थ |
|---|---|
0 | सफलता |
1 | प्रतीक्षा के दौरान टास्क विफल हो गया या CANCELED कर दिया गया, या कोई अन्य त्रुटि |
2 | अमान्य फ्लैग या आर्गुमेंट |
3 | प्रमाणीकरण विफल रहा, या कोई क्रेडेंशियल नहीं है |
4 | API ने अनुरोध अस्वीकार कर दिया (400, 422) |
5 | नहीं मिला (404) |
6 | दर सीमित (429) |
7 | नेटवर्क त्रुटि |
8 | प्रतीक्षा करते समय समय समाप्त हो गया। टास्क चलता रहता है। |
9 | पर्याप्त क्रेडिट नहीं हैं (402) |
10 | क्रिएट अनुरोध भेजा गया था, लेकिन इसका परिणाम अज्ञात है। पुनः प्रयास करने से पहले meshy <resource> list जाँचें। |
130 | Ctrl-C से बाधित किया गया |
कोड 11 से 14 और पूर्ण आउटपुट प्रारूप के लिए, Scripts and agents देखें।
GitHub Actions
अपनी API की को MESHY_API_KEY नाम से रिपॉजिटरी सीक्रेट के रूप में सेव करें, फिर किसी जॉब में CLI चलाएँ:
.github/workflows/meshy.yml
name: Generate a model
on: workflow_dispatch
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-node@v4
with:
node-version: 22
- run: npm install -g meshy-cli
- run: meshy make "a low-poly treasure chest" -o assets/chest/ --format json
env:
MESHY_API_KEY: ${{ secrets.MESHY_API_KEY }}
- uses: actions/upload-artifact@v4
with:
name: chest
path: assets/chest/
जब CLI नॉन-ज़ीरो कोड के साथ एग्ज़िट होता है, तो यह स्टेप विफल हो जाता है।
AI एजेंट्स
कोई भी एजेंट जो शेल कमांड चला सकता है, वह CLI का उपयोग कर सकता है, जिसमें Claude Code, Cursor और Codex शामिल हैं। एजेंट को JSON अपने आप मिल जाता है।
अपने एजेंट को Meshy वर्कफ़्लो सिखाने के लिए, ओपन-सोर्स meshy-3d-agent स्किल पैक इंस्टॉल करें। यह CLI पर चलता है।
npx skills add meshy-dev/meshy-3d-agent
रेफरेंस
ग्लोबल फ़्लैग्स
ये फ़्लैग हर कमांड पर काम करते हैं:
| फ़्लैग | विवरण |
|---|---|
--format json|pretty|ndjson | आउटपुट फ़ॉर्मैट। --json, --format json का संक्षिप्त रूप है। |
-o, --output <path> | पूर्ण हो चुके टास्क की फ़ाइलों को किसी फ़ोल्डर में सहेजें, या एक फ़ाइल को car.glb जैसे पथ पर सहेजें |
--all-assets | -o के साथ, टेक्सचर मैप और अन्य अतिरिक्त फ़ाइलें भी सहेजें |
--workspace <dir> | फ़ाइलें केवल इसी फ़ोल्डर के अंदर लिखें |
--api-key <key> | इस API की का उपयोग करें |
--api-key-file <path> | किसी फ़ाइल से MESHY_API_KEY पढ़ें |
--no-update-check | नए वर्शन की जाँच छोड़ें |
-v, --verbose | डीबग लॉग stderr पर प्रिंट करें |
एनवायरनमेंट वेरिएबल
CLI इन वेरिएबल को पढ़ता है:
| वेरिएबल | विवरण |
|---|---|
MESHY_API_KEY | API की। किसी संग्रहीत साइन-इन पर प्राथमिकता लेता है। |
MESHY_REGION | global या cn। डिफ़ॉल्ट: आपके साइन-इन का क्षेत्र, अन्यथा global |
MESHY_CLI_NO_BROWSER | कोई भी मान CLI को ब्राउज़र खोलने से रोकता है, और meshy auth login डिवाइस कोड का उपयोग करता है |
MESHY_CONFIG_DIR | CLI अपनी फ़ाइलें कहाँ रखता है। डिफ़ॉल्ट: ~/.config/meshy |
MESHY_KEYRING | file एन्क्रिप्शन कुंजी को OS चाबी के छल्ले के बजाय एक फ़ाइल में रखता है |
MESHY_CLI_AGENT | none User-Agent हेडर से AI एजेंट का नाम हटा देता है |
NO_COLOR | रंग बंद कर देता है |
क्रेडेंशियल कहाँ संग्रहीत होते हैं
CLI क्रेडेंशियल को ~/.config/meshy/credentials.v2.json में संग्रहीत करता है, जिसे केवल आप ही पढ़ सकते हैं। इसमें मौजूद क्रेडेंशियल को OS चाबी के छल्ले में रखी एक कुंजी से एन्क्रिप्ट किया जाता है: macOS पर चाबी का छल्ला, Windows पर DPAPI, या Linux पर Secret Service। जहाँ कोई चाबी का छल्ला उपलब्ध नहीं है, जैसे किसी कंटेनर में या SSH के माध्यम से, वहाँ कुंजी क्रेडेंशियल के बगल में एक फ़ाइल होती है।
अपडेट और अनइंस्टॉल
CLI अधिकतम दिन में एक बार npm पर नए संस्करण की जाँच करता है और आपको stderr पर बताता है। यह आपके stdout को कभी नहीं बदलता। प्रत्येक API अनुरोध में CLI संस्करण, आपका OS, और CLI चलाने वाला AI एजेंट (यदि यह किसी का पता लगाता है) के साथ एक User-Agent हेडर होता है। एजेंट को छोड़ने के लिए, MESHY_CLI_AGENT=none सेट करें।
Update
npm install -g meshy-cli@latest
Uninstall
meshy auth logout --all # deletes the stored credentials
npm uninstall -g meshy-cli
यह देखने के लिए कि प्रत्येक संस्करण में क्या बदला है, GitHub पर releases देखें।
Troubleshooting
पहले meshy doctor चलाएँ। यह API को कॉल किए बिना आपके सेटअप की जाँच करता है। ये सामान्य समस्याएँ हैं:
| समस्या | समाधान |
|---|---|
इंस्टॉल करते समय EEXIST | आपके पास दूसरा पैकेज इंस्टॉल है। npm uninstall -g @meshy-ai/cli चलाएँ, फिर meshy-cli इंस्टॉल करें। |
| ब्राउज़र नहीं खुलता | meshy auth login द्वारा प्रिंट किया गया URL कॉपी करें, या meshy auth login --device का उपयोग करें। |
| CLI गलत खाते का उपयोग करता है | MESHY_API_KEY को आपके साइन-इन पर प्राथमिकता मिलती है। यह देखने के लिए कि कौन सा क्रेडेंशियल प्रभावी है, meshy auth status चलाएँ। |
| लॉक की गई चाबी का छल्ला साइन-इन को रोकती है | MESHY_KEYRING=file सेट करें। |
क्रिएट के बाद एग्ज़िट कोड 10 | CLI यह नहीं बता सकता कि टास्क बनाया गया था या नहीं। पुनः प्रयास करने से पहले meshy <resource> list चलाएँ, ताकि आप दोबारा भुगतान न करें। |
बग की रिपोर्ट करने के लिए, meshy-cli रिपॉज़िटरी में एक इश्यू खोलें।
अगले चरण
- प्रत्येक एंडपॉइंट के पैरामीटर और लागतें API संदर्भ में देखें।
- AI इंटीग्रेशन में CLI की MCP server से तुलना करें।
- हर कमांड और फ्लैग के लिए Using meshy-cli पढ़ें।