Meshy CLI

Gumawa, subaybayan, at i-download ang mga Meshy model mula sa iyong terminal. Ang isang command ay nagpapalit ng prompt o imahe tungo sa isang model na may texture, at karamihan sa mga API endpoint ay mga command na rin mismo.

Ang Meshy CLI (meshy) ay tumatawag sa parehong REST API na ginagamit ng iba pang bahagi ng mga dokumentong ito, sa parehong presyo. Mag-sign in ka nang isang beses sa iyong browser, kaya hindi mo kailangan ng API key. Sa isang terminal, nagpapakita ito ng madaling basahing view, at sa isang script, pipe, CI, o isang AI agent, naglilimbag ito ng JSON.

I-install

Kailangan ng CLI ang Node.js 22.12 o mas bago. Tumatakbo ito sa macOS, Linux, at Windows.

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

Nag-i-install ang package ng dalawang command, meshy at meshy-cli. Ang parehong build ay nailathala rin bilang @meshy-ai/cli. I-install lamang ang isa sa dalawang package, dahil pareho silang nagbibigay ng meshy command at tatanggihan ng npm ang pangalawa gamit ang EEXIST.

Open source ang CLI. Nasa meshy-cli repository sa GitHub ang source nito.

Mag-sign In

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

Binubuksan ng meshy auth login ang isang Meshy sign-in page sa iyong browser at itinatago ang kredensyal sa iyong computer. Kung hindi bumukas ang browser, kopyahin ang URL na ipinapakita ng CLI.

Mga remote machine, SSH at container

Sa isang machine na walang browser, ang meshy auth login ay magpapakita ng link at maikling code sa halip. Buksan ang link sa anumang device, tulad ng iyong laptop o telepono, mag-sign in, at ilagay ang code. Tatapusin ng CLI ang sign-in nang mag-isa.

Pinipili ng CLI ang daloy na ito kapag na-detect nito ang SSH, isang container, CI, Linux na walang display, o walang interactive na terminal, tulad ng kapag ang isang AI agent ang nagpapatakbo ng command. Pinipili rin nito ito kapag naka-set ang MESHY_CLI_NO_BROWSER. Upang piliin ito mismo, patakbuhin ang meshy auth login --device.

meshy auth login --device

Mga API key at CI

Para sa CI at iba pang unattended na mga trabaho, gumamit ng API key sa halip na pag-sign in gamit ang browser. Itakda ito sa MESHY_API_KEY environment variable. Mayroon itong priority kaysa sa naka-imbak na sign-in.

export MESHY_API_KEY="msy_YOUR_API_KEY"
meshy balance

Maaari ka ring mag-imbak ng key gamit ang meshy auth login --with-key msy_YOUR_API_KEY.

Ginagamit ng CLI ang unang credential na matatagpuan nito, sa ganitong pagkakasunod-sunod: --api-key, MESHY_API_KEY, --api-key-file, at pagkatapos ang naka-imbak na sign-in. Kung ibang account ang ginagamit ng CLI kaysa sa inaasahan mo, patakbuhin ang meshy auth status upang makita kung aling credential ang kasalukuyang ginagamit.

Site ng China

Isang Meshy account ang gumagana sa parehong mga site. Upang gamitin ang meshy.cn, mag-sign in gamit ang meshy auth login --region cn. Iniimbak ng CLI ang rehiyon kasama ng iyong sign-in, kaya ang mga susunod na command ay tumatawag sa api.meshy.cn nang walang flag. Upang bumalik, mag-sign in gamit ang --region global.

Gumawa ng iyong unang model

Pinapatakbo ng meshy make ang buong daloy sa isang command. Ang isang text prompt ay nagpapatakbo ng Text to 3D preview at pagkatapos ay isang refine. Ang isang larawan ay nagpapatakbo ng isang textured na Image to 3D task.

Una, tingnan kung ano ang gagawin ng isang run at ilang credits ang ikakagastos nito, nang hindi gumagastos ng anuman:

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

Pagkatapos, patakbuhin ito, at i-save ang model sa isang folder gamit ang -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

Ang folder ngayon ay naglalaman ng model, ang thumbnail nito, at isang meta.json file. Upang magsimula sa isang larawan sa halip, ipasa ang path o URL nito: meshy make ./cat.png -o out/cat/.

Commands

Karamihan sa mga API endpoint ay mga command na mayroong sariling katawan, at ang bawat task command ay gumagamit ng parehong mga verb: create, get, list, wait, stream, at delete. Para sa isang endpoint na walang sariling command, gamitin ang meshy api.

Saklaw ng mga command na ito ang mga karaniwang gawain:

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

Para sa mga flag ng isang command, patakbuhin ang meshy <resource> --help. Para sa mga parameter at gastos sa credit ng bawat endpoint, tingnan ang kaukulang pahina nito sa mga dokumentong ito, tulad ng Text to 3D.

Mayroon din sa CLI na mga lokal na tulong para sa 3D printing, tulad ng meshy inspect faces, meshy mesh prepare-print at meshy slicer. Tumatakbo ang mga ito sa iyong computer at hindi tumatawag sa API. Tingnan ang Using meshy-cli para sa bawat command.

Mga script, ahente, at CI

JSON output

Kapag ang output nito ay napupunta sa isang pipe, isang file, isang script, o isang AI agent, nagpi-print ang CLI ng JSON. Sa isang terminal, nagpi-print ito ng isang nababasang view. Ipasa ang --format json (o --json) upang laging makakuha ng JSON.

Bawat command ay nagpi-print ng eksaktong isang JSON document sa stdout, na may parehong anim na key. Ang progress at mga mensahe ay napupunta sa 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": []
}

Sinasabi ng ok kung gumana ang CLI command. Ang sariling estado ng task ay nasa result.task.status. Halimbawa, ang get sa isang nabigong task ay nagbabalik ng ok: true, dahil gumana naman ang request mismo.

Ipinapadala ng CLI ang bawat create request nang isang beses lamang at hindi ito kailanman inuulit nang mag-isa, kaya't ang isang network error ay hindi makakagawa, at makakasingil, para sa ikalawang task.

Exit codes

Sinasabi ng exit code kung ano ang nangyari:

Para sa mga code 11 hanggang 14 at sa kumpletong output format, tingnan ang Scripts and agents.

GitHub Actions

Itago ang iyong API key bilang repository secret na pinangalanang MESHY_API_KEY, pagkatapos ay patakbuhin ang CLI sa isang 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/

Nabibigo ang hakbang kapag nag-exit ang CLI nang may non-zero code.

Mga AI agent

Anumang agent na makapagpapatakbo ng mga shell command ay maaaring gumamit ng CLI, kabilang ang Claude Code, Cursor, at Codex. Awtomatikong nakukuha ng agent ang JSON.

Upang ituro sa iyong agent ang mga Meshy workflow, i-install ang open-source na meshy-3d-agent skill pack. Tumatakbo ito sa CLI.

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

Reference

Mga Global flag

Gumagana ang mga flag na ito sa bawat command:

Mga environment variable

Binabasa ng CLI ang mga variable na ito:

Saan nakaimbak ang mga kredensyal

Iniimbak ng CLI ang mga kredensyal sa ~/.config/meshy/credentials.v2.json, na mababasa lamang ng may-ari. Ang kredensyal dito ay naka-encrypt gamit ang isang key na naka-imbak sa OS keychain: Keychain sa macOS, DPAPI sa Windows, o Secret Service sa Linux. Kung saan walang available na keychain, gaya ng sa isang container o sa SSH, ang key ay isang file na katabi ng mga kredensyal.

Mga update at pag-uninstall

Sinusuri ng CLI ang npm para sa bagong bersyon nang hindi hihigit sa isang beses bawat araw at ipinapaalam ito sa iyo sa stderr. Hindi nito binabago ang iyong stdout. Bawat kahilingan sa API ay may dalang User-Agent header na naglalaman ng bersyon ng CLI, ang iyong OS, at ang AI agent na nagpapatakbo ng CLI, kung may nadetect ito. Upang hindi isama ang agent, itakda ang MESHY_CLI_AGENT=none.

npm install -g meshy-cli@latest

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

Upang makita kung ano ang nagbago sa bawat bersyon, tingnan ang releases sa GitHub.

Troubleshooting

Patakbuhin muna ang meshy doctor. Sinusuri nito ang iyong setup nang hindi tumatawag sa API. Narito ang mga karaniwang problema:

Upang mag-report ng bug, magbukas ng isyu sa meshy-cli repository.

Mga susunod na hakbang

• Tingnan ang mga parameter at gastos ng bawat endpoint sa API reference.
• Ihambing ang CLI sa MCP server sa AI Integration.
• Basahin ang Using meshy-cli para sa bawat command at flag.