Meshy CLI

Buat, lacak, dan unduh model Meshy langsung dari terminal Anda. Satu perintah mengubah prompt atau gambar menjadi model bertekstur, dan sebagian besar endpoint API memiliki perintahnya masing-masing.

Meshy CLI (meshy) memanggil REST API yang sama dengan yang digunakan dokumentasi lainnya, dengan harga yang sama. Anda masuk sekali di browser, sehingga Anda tidak memerlukan kunci API. Di terminal, perintah ini menampilkan tampilan yang mudah dibaca, dan di skrip, pipa, CI, atau agen AI, perintah ini menampilkan JSON.

Install

CLI memerlukan Node.js 22.12 atau yang lebih baru. CLI berjalan di macOS, Linux, dan Windows.

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

Paket ini menginstal dua perintah, meshy dan meshy-cli. Build yang sama juga dipublikasikan sebagai @meshy-ai/cli. Instal hanya salah satu dari kedua paket tersebut, karena keduanya menyediakan perintah meshy dan npm akan menolak paket kedua dengan EEXIST.

CLI ini bersifat open source. Sumber kodenya ada di meshy-cli repository di GitHub.

Sign in

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

meshy auth login membuka halaman sign-in Meshy di browser Anda dan menyimpan kredensial di komputer Anda. Jika browser tidak terbuka, salin URL yang ditampilkan oleh CLI.

Mesin remote, SSH, dan container

Pada mesin tanpa browser, meshy auth login akan menampilkan tautan dan kode singkat sebagai gantinya. Buka tautan tersebut di perangkat mana pun, seperti laptop atau ponsel Anda, lakukan sign-in, lalu masukkan kodenya. CLI akan menyelesaikan proses sign-in dengan sendirinya.

CLI memilih alur ini saat mendeteksi SSH, container, CI, Linux tanpa display, atau tidak ada terminal interaktif, seperti saat sebuah agen AI menjalankan perintah tersebut. CLI juga memilih alur ini saat MESHY_CLI_NO_BROWSER diset. Untuk memilihnya sendiri, jalankan meshy auth login --device.

meshy auth login --device

Kunci API dan CI

Untuk CI dan pekerjaan tanpa pengawasan lainnya, gunakan kunci API alih-alih sign-in melalui browser. Setel ini pada variabel lingkungan MESHY_API_KEY. Variabel ini memiliki prioritas lebih tinggi daripada sign-in yang tersimpan.

export MESHY_API_KEY="msy_YOUR_API_KEY"
meshy balance

Anda juga dapat menyimpan kunci dengan meshy auth login --with-key msy_YOUR_API_KEY.

CLI menggunakan kredensial pertama yang ditemukannya, dengan urutan sebagai berikut: --api-key, MESHY_API_KEY, --api-key-file, lalu sign-in yang tersimpan. Jika CLI menggunakan akun yang berbeda dari yang Anda harapkan, jalankan meshy auth status untuk melihat kredensial mana yang sedang berlaku.

Situs China

Satu akun Meshy berfungsi di kedua situs. Untuk menggunakan meshy.cn, masuk dengan meshy auth login --region cn. CLI menyimpan wilayah bersama sesi masuk Anda, sehingga perintah berikutnya memanggil api.meshy.cn tanpa flag tambahan. Untuk beralih kembali, masuk dengan --region global.

Buat model pertama Anda

meshy make menjalankan seluruh alur dalam satu perintah. Sebuah text prompt menjalankan preview Teks ke 3D lalu refine. Sebuah gambar menjalankan satu tugas Gambar ke 3D bertekstur.

Pertama, periksa apa yang akan dilakukan oleh sebuah run dan berapa kredit yang akan dikenakan, tanpa benar-benar menggunakannya:

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

Lalu jalankan, dan simpan model ke sebuah folder dengan -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

Folder tersebut kini berisi model, thumbnail-nya, dan sebuah file meta.json. Untuk memulai dari sebuah foto, berikan path atau URL-nya: meshy make ./cat.png -o out/cat/.

Commands

Sebagian besar endpoint API merupakan command tersendiri, dan setiap task command menggunakan verba yang sama: create, get, list, wait, stream, dan delete. Untuk endpoint yang tidak memiliki command sendiri, gunakan meshy api.

Command-command berikut mencakup task yang umum digunakan:

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

Untuk flag dari suatu command, jalankan meshy <resource> --help. Untuk parameter dan biaya credit setiap endpoint, lihat halamannya di dokumentasi ini, seperti Text to 3D.

CLI ini juga memiliki helper lokal untuk pencetakan 3D, seperti meshy inspect faces, meshy mesh prepare-print, dan meshy slicer. Perintah-perintah ini berjalan di komputer Anda dan tidak memanggil API. Lihat Using meshy-cli untuk daftar lengkap command.

Skrip, agen, dan CI

Output JSON

Ketika outputnya diarahkan ke pipe, file, skrip, atau agen AI, CLI mencetak JSON. Di terminal, CLI mencetak tampilan yang mudah dibaca. Berikan --format json (atau --json) untuk selalu mendapatkan JSON.

Setiap perintah mencetak tepat satu dokumen JSON pada stdout, dengan enam kunci yang sama. Progress dan pesan dikirim ke 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 menunjukkan apakah perintah CLI berhasil dijalankan. Status task itu sendiri ada di result.task.status. Misalnya, get pada task yang FAILED tetap mengembalikan ok: true, karena permintaan itu sendiri berhasil dijalankan.

CLI mengirim setiap permintaan create satu kali dan tidak pernah mencobanya ulang secara otomatis, sehingga kesalahan jaringan tidak dapat membuat, dan mengenakan biaya untuk, task kedua.

Kode keluar (Exit codes)

Kode keluar memberi tahu skrip apa yang terjadi:

Untuk kode 11 hingga 14 dan format keluaran lengkap, lihat Scripts and agents.

GitHub Actions

Simpan kunci API Anda sebagai repository secret dengan nama MESHY_API_KEY, lalu jalankan CLI dalam sebuah job:

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/

Langkah ini akan gagal jika CLI keluar dengan kode non-nol.

Agen AI

Agen apa pun yang dapat menjalankan perintah shell dapat menggunakan CLI, termasuk Claude Code, Cursor, dan Codex. Agen tersebut mendapatkan JSON secara otomatis.

Untuk mengajarkan workflow Meshy kepada agen Anda, instal skill pack open-source meshy-3d-agent. Skill pack ini berjalan di CLI.

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

Referensi

Flag global

Flag-flag ini bekerja pada setiap perintah:

Variabel lingkungan

CLI membaca variabel-variabel berikut:

Di mana kredensial disimpan

CLI menyimpan kredensial di ~/.config/meshy/credentials.v2.json, yang hanya dapat dibaca oleh Anda. Kredensial di dalamnya dienkripsi dengan kunci yang disimpan di gantungan kunci OS: Keychain di macOS, DPAPI di Windows, atau Secret Service di Linux. Jika tidak ada gantungan kunci yang tersedia, seperti dalam kontainer atau melalui SSH, kuncinya adalah berkas di samping kredensial tersebut.

Pembaruan dan pencopotan pemasangan

CLI memeriksa npm untuk versi baru paling banyak sekali sehari dan memberi tahu Anda melalui stderr. CLI tidak pernah mengubah stdout Anda. Setiap permintaan API membawa header User-Agent dengan versi CLI, OS Anda, dan agen AI yang menjalankan CLI, jika terdeteksi. Untuk tidak menyertakan agen, atur MESHY_CLI_AGENT=none.

npm install -g meshy-cli@latest

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

Untuk melihat apa yang berubah di setiap versi, lihat releases di GitHub.

Pemecahan masalah

Jalankan meshy doctor terlebih dahulu. Perintah ini memeriksa pengaturan Anda tanpa memanggil API. Berikut masalah-masalah yang umum terjadi:

Untuk melaporkan bug, buka issue di repositori meshy-cli.

Langkah selanjutnya

• Lihat parameter dan biaya setiap endpoint di referensi API.
• Bandingkan CLI dengan MCP server di Integrasi AI.
• Baca Menggunakan meshy-cli untuk semua perintah dan flag.