Meshy CLI

สร้าง ติดตาม และดาวน์โหลดโมเดล Meshy จากเทอร์มินัลของคุณ คำสั่งเดียวสามารถเปลี่ยน prompt หรือรูปภาพให้กลายเป็นโมเดลที่มี texture ได้ และ API เอนด์พอยต์ส่วนใหญ่ก็เป็นคำสั่งในตัวของมันเอง

Meshy CLI (meshy) เรียกใช้ REST API ตัวเดียวกับที่ใช้ในเอกสารชุดนี้ ในราคาเดียวกัน คุณเข้าสู่ระบบเพียงครั้งเดียวในเบราว์เซอร์ จึงไม่จำเป็นต้องใช้ API คีย์ เมื่อใช้งานในเทอร์มินัล มันจะแสดงผลในรูปแบบที่อ่านง่าย และเมื่อใช้งานในสคริปต์ ไปป์ CI หรือเอเจนต์ AI มันจะแสดงผลเป็น JSON

ติดตั้ง

CLI ต้องใช้ Node.js 22.12 หรือใหม่กว่า โดยสามารถทำงานได้บน macOS, Linux และ Windows

npm install -g meshy-cli
meshy doctor    # checks your environment, without calling the API

แพ็กเกจนี้จะติดตั้งคำสั่งสองคำสั่ง ได้แก่ meshy และ meshy-cli โดยบิลด์เดียวกันนี้ยังเผยแพร่ในชื่อ @meshy-ai/cli อีกด้วย ให้ติดตั้งเพียงแพ็กเกจใดแพ็กเกจหนึ่งจากทั้งสอง เนื่องจากทั้งคู่ให้คำสั่ง meshy เหมือนกัน และ npm จะปฏิเสธแพ็กเกจตัวที่สองด้วยข้อผิดพลาด EEXIST

CLI นี้เป็นโอเพนซอร์ส โค้ดต้นฉบับอยู่ที่ meshy-cli repository บน GitHub

เข้าสู่ระบบ

meshy auth login     # opens your browser
meshy auth status    # shows which account and credential are in use

meshy auth login จะเปิดหน้าเข้าสู่ระบบของ Meshy ในเบราว์เซอร์ของคุณและจัดเก็บข้อมูลรับรอง (credential) ไว้ในเครื่องคอมพิวเตอร์ของคุณ หากเบราว์เซอร์ไม่เปิดขึ้นมา ให้คัดลอก URL ที่ CLI แสดงออกมา

เครื่องระยะไกล, SSH และคอนเทนเนอร์

บนเครื่องที่ไม่มีเบราว์เซอร์ meshy auth login จะแสดงลิงก์และรหัสสั้น ๆ แทน เปิดลิงก์นั้นบนอุปกรณ์ใดก็ได้ เช่น แล็ปท็อปหรือโทรศัพท์ของคุณ เข้าสู่ระบบ แล้วกรอกรหัสนั้น CLI จะดำเนินการเข้าสู่ระบบให้เสร็จสมบูรณ์เอง

CLI จะเลือกใช้โฟลว์นี้เมื่อตรวจพบ SSH, คอนเทนเนอร์, CI, Linux ที่ไม่มีจอแสดงผล หรือไม่มีเทอร์มินัลแบบโต้ตอบ เช่นเมื่อ AI agent เป็นผู้รันคำสั่งนี้ นอกจากนี้ยังเลือกใช้โฟลว์นี้เมื่อมีการตั้งค่า MESHY_CLI_NO_BROWSER ไว้ด้วย หากต้องการเลือกใช้โฟลว์นี้ด้วยตัวเอง ให้รัน meshy auth login --device

meshy auth login --device

API คีย์และ CI

สำหรับ CI และงานอื่น ๆ ที่ไม่มีการโต้ตอบ ให้ใช้ API คีย์ แทนการลงชื่อเข้าใช้ผ่านเบราว์เซอร์ ตั้งค่าใน environment variable ชื่อ MESHY_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 แล้วตามด้วย refine ส่วนรูปภาพจะรันงานรูปภาพเป็น 3D แบบมีพื้นผิวหนึ่งงาน

ก่อนอื่น ตรวจสอบว่าการรันจะทำอะไรและใช้เครดิตเท่าไร โดยไม่ต้องเสียเครดิตจริง:

meshy make "a lovely baby husky" --dry-run

จากนั้นรันคำสั่งจริง และบันทึกโมเดลลงในโฟลเดอร์ด้วย -o:

meshy make "a lovely baby husky" -o out/husky/

✓ [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 จะใช้คำกริยาชุดเดียวกัน ได้แก่ create, get, list, wait, stream และ delete สำหรับเอนด์พอยต์ที่ไม่มีคำสั่งเฉพาะของตัวเอง ให้ใช้ meshy api

คำสั่งเหล่านี้ครอบคลุมงานทั่วไป:

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 <resource> --help ส่วนพารามิเตอร์และต้นทุน credit ของแต่ละเอนด์พอยต์ ดูได้ในหน้าเอกสารของแต่ละตัว เช่น Text to 3D

CLI ยังมีตัวช่วยที่ทำงานในเครื่องสำหรับ การพิมพ์ 3 มิติ เช่น meshy inspect faces, meshy mesh prepare-print และ meshy slicer คำสั่งเหล่านี้ทำงานบนคอมพิวเตอร์ของคุณเองและไม่ได้เรียกใช้ API ดูคำสั่งทั้งหมดได้ที่ Using meshy-cli

Scripts, agents, and CI

JSON output

เมื่อเอาต์พุตของมันถูกส่งไปยัง pipe ไฟล์ สคริปต์ หรือ AI agent CLI จะพิมพ์ออกมาเป็น JSON แต่ในเทอร์มินัลมันจะพิมพ์ในรูปแบบที่อ่านง่าย ส่งพารามิเตอร์ --format json (หรือ --json) เพื่อให้ได้ JSON เสมอ

ทุกคำสั่งจะพิมพ์เอกสาร JSON เพียงหนึ่งชุดออกทาง stdout โดยมีคีย์เดียวกันหกตัวเสมอ ส่วน progress และข้อความต่าง ๆ จะถูกส่งออกทาง stderr

meshy text-to-3d create --mode preview --prompt "a cactus" --async --format json \
  | jq -r .result.submission.task_id

{
  "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 นั้นทำงานสำเร็จหรือไม่ ส่วนสถานะของ task เองจะอยู่ใน result.task.status ตัวอย่างเช่น การเรียก get กับ task ที่ FAILED จะคืนค่า ok: true เพราะตัวคำขอเองทำงานได้สำเร็จ

CLI จะส่งคำขอ create แต่ละครั้งเพียงครั้งเดียวและจะไม่ลองใหม่ด้วยตัวมันเองเด็ดขาด ดังนั้นข้อผิดพลาดทางเครือข่ายจึงไม่สามารถสร้าง task ที่สองและเรียกเก็บเงินซ้ำได้

รหัสการออก (Exit codes)

รหัสการออกบอกให้สคริปต์ทราบว่าเกิดอะไรขึ้น:

สำหรับรหัส 11 ถึง 14 และรูปแบบผลลัพธ์แบบเต็ม โปรดดูที่ Scripts and agents

GitHub Actions

จัดเก็บ API คีย์ของคุณเป็นความลับของที่เก็บข้อมูล (repository secret) ในชื่อ MESHY_API_KEY จากนั้นรัน CLI ในจ็อบ:

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 agents

เอเจนต์ใดก็ตามที่สามารถรันคำสั่ง shell ได้สามารถใช้ CLI ได้ รวมถึง Claude Code, Cursor และ Codex โดยเอเจนต์จะได้รับ JSON โดยอัตโนมัติ

หากต้องการสอนเวิร์กโฟลว์ของ Meshy ให้กับเอเจนต์ของคุณ ให้ติดตั้ง skill pack แบบโอเพนซอร์ส meshy-3d-agent ซึ่งทำงานบน CLI

npx skills add meshy-dev/meshy-3d-agent

Reference

Global flags

แฟล็กเหล่านี้ใช้ได้กับทุกคำสั่ง:

ตัวแปรสภาพแวดล้อม

CLI จะอ่านตัวแปรเหล่านี้:

ที่เก็บข้อมูลประจำตัว

CLI จัดเก็บข้อมูลประจำตัวไว้ที่ ~/.config/meshy/credentials.v2.json ซึ่งอ่านได้โดยคุณเท่านั้น ข้อมูลประจำตัวในไฟล์นี้ถูกเข้ารหัสด้วยคีย์ที่เก็บไว้ใน OS keychain ของระบบปฏิบัติการ: Keychain บน macOS, DPAPI บน Windows หรือ Secret Service บน Linux ในกรณีที่ไม่มี keychain ให้ใช้ เช่น ในคอนเทนเนอร์หรือผ่าน SSH คีย์จะเป็นไฟล์ที่อยู่ข้างๆ ข้อมูลประจำตัว

การอัปเดตและการถอนการติดตั้ง

CLI จะตรวจสอบ npm เพื่อหาเวอร์ชันใหม่อย่างมากที่สุดวันละหนึ่งครั้ง และแจ้งให้คุณทราบผ่าน stderr โดยจะไม่เปลี่ยนแปลง stdout ของคุณเลย คำขอ API แต่ละครั้งจะมีส่วนหัว User-Agent ที่ระบุเวอร์ชันของ CLI ระบบปฏิบัติการของคุณ และ AI agent ที่กำลังรัน CLI อยู่ หากตรวจพบ หากต้องการไม่ให้แสดง agent ให้ตั้งค่า MESHY_CLI_AGENT=none

npm install -g meshy-cli@latest

meshy auth logout --all       # deletes the stored credentials
npm uninstall -g meshy-cli

หากต้องการดูว่ามีการเปลี่ยนแปลงอะไรบ้างในแต่ละเวอร์ชัน โปรดดู releases บน GitHub

การแก้ปัญหา

รันคำสั่ง meshy doctor ก่อนเป็นอันดับแรก คำสั่งนี้จะตรวจสอบการตั้งค่าของคุณโดยไม่เรียกใช้ API ต่อไปนี้คือปัญหาที่พบบ่อย:

หากต้องการรายงานข้อผิดพลาด ให้เปิด issue ใน meshy-cli repository

ขั้นตอนถัดไป

• ดูพารามิเตอร์และค่าใช้จ่ายของแต่ละเอนด์พอยต์ได้ใน API reference
• เปรียบเทียบ CLI กับ MCP server ได้ใน การเชื่อมต่อ AI
• อ่าน Using meshy-cli เพื่อดูทุกคำสั่งและแฟล็กทั้งหมด