tripo-cli

command module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2026 License: MIT Imports: 6 Imported by: 0

README

Tripo CLI

npm version

English | 中文版

Official CLI for the Tripo 3D generation platform — enabling both humans and AI agents to generate 3D models from the terminal. Supports text/image generation, post-processing (rig, animate, texture, stylize, remesh), export, and comes with AI Agent Skills out of the box.

Install · AI Agent Quick Start · Commands · Configuration

Why Tripo CLI?

  • Agent-native design — AI Skills out of the box, compatible with Claude Code / Cursor / Windsurf / Codex
  • One command, one modeltripo generate text "a chair" --wait -o ./chair.glb, zero manual steps from submit to download
  • Full pipeline — Generate → Post-process → Export, one CLI covers it all
  • Open source, zero barrier — MIT license, npm install and go

Install

Prerequisites
  • Node.js 18+ (npm/npx)
Quick Start (Human Users)

Note for AI assistants: If you are an AI agent helping a user install, skip to Quick Start (AI Agent).

# 1. Install
npm install -g @tripo3d/cli

# 2. Login (complete email verification in browser)
tripo auth login

# 3. Generate a 3D model
tripo generate text "a medieval castle" --wait -o ./castle.glb
Quick Start (AI Agent)

The following steps are for AI agents. Some steps require user interaction in a browser.

Step 1 — Install

npx @tripo3d/cli@latest install

This command automatically:

  • Installs the tripo3d skill to the appropriate agent directory (auto-detects Claude Code / Cursor / Windsurf / Codex)
  • Falls back to ~/.claude/skills/tripo3d/ if no known agent is detected

Step 2 — Authenticate

tripo auth login

The command outputs a verification URL. Extract the URL and send it to the user. The command exits automatically after browser verification.

Step 3 — Verify

tripo auth whoami

Commands

tripo generate text|image|multiview     Generate 3D models
tripo image [prompt]                    Generate images (text-to-image / image-to-image)
tripo image list|get                    Manage generated images
tripo process rig|animate|texture|...   Post-processing
tripo export <project-id>               Export and download
tripo task get|status|wait|list         Task management
tripo account balance|prices            Account info
tripo auth login|whoami|logout          Authentication
tripo config show|use|create|delete|set Profile management
tripo install                           Install AI agent skill
tripo update                            Self-update to latest version
tripo version                           Print version info
Generate
# Text to 3D
tripo generate text "a red sneaker, studio lighting" --wait -o ./sneaker.glb

# Image to 3D
tripo generate image ./photo.png --wait -o ./model.glb

# Multiview (2-8 images)
tripo generate multiview ./front.png ./side.png ./back.png --wait -o ./model.glb
Post-Processing
# Rig a character (check first, then rig)
tripo process rig <project-id> --check
tripo process rig <project-id> -o ./rigged.glb

# Animate
tripo process animate <project-id> --animations "preset:biped:walk" -o ./animated.glb

# Stylize
tripo process stylize <project-id> --style lego -o ./lego.glb
Image Generation
# Text to image (default model: gemini_2.5_flash_image_preview)
tripo image "a cute cat sitting on the moon"

# With specific model
tripo image "a fantasy castle" --model midjourney

# Image to image (transform an existing image)
tripo image "transform to watercolor painting" -i ./photo.png

# Batch generation with aspect ratio
tripo image "a product logo" --amount 4 --scale 16:9

# Download result
tripo image "a sunset landscape" -o ./sunset.png

# List your generated images
tripo image list

# Get details of a specific image
tripo image get <asset-id>

Available models: gemini_2.5_flash_image_preview, gemini_3_pro_image_preview, gemini_3.1_flash_image_preview, midjourney, gpt_image_1.5, gpt_image_2

Export
tripo export <project-id> --format fbx -o ./model.fbx

Model Versions

Version Use Case
v3.1-20260211 Highest quality (default)
v3.0-20250812 Good quality, faster
v2.5-20250123 Balanced
Nexus-v1.0-20260214 Fast, lightweight

Update

# Self-update binary + reinstall skills (one command does it all)
tripo update

# Check if update available without installing
tripo update --check

For npm installations:

npm update -g @tripo3d/cli && tripo install

The CLI automatically notifies you when a new minor/major version is available. Patch updates (e.g. 0.4.1 → 0.4.2) do not trigger notifications.

Configuration

Multi-profile support:

tripo config show                    # View current settings
tripo config create staging          # New profile
tripo config use staging             # Switch profile
tripo config set output_format json  # Set value
Environment Variables
Variable Purpose
TRIPO_BASE_URL Override API endpoint
TRIPO_PROFILE Select config profile
TRIPO_OUTPUT_FORMAT Output format (text/json/table)
TRIPO_TIMEOUT Global timeout (e.g. 60s)
Priority Chain
--flag > ENV variable > config.yaml > default

Output Formats

# Human-readable (default)
tripo task list

# JSON for scripting
tripo task list --output-format json

# Quiet mode — just the result
tripo generate text "a chair" --wait -o ./chair.glb -q

Development

make build      # Build binary to ./bin/tripo
make test       # Run tests with race detector
make lint       # Run golangci-lint
make integration-test  # Real API tests (~16 min, consumes credits)
Build from Source
git clone https://github.com/vast-enterprise/cli.git
cd cli
make build
./bin/tripo --help

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
audit
Package audit submits uploaded images to the backend's content moderation endpoint and returns a typed verdict callers can fold into a request body.
Package audit submits uploaded images to the backend's content moderation endpoint and returns a typed verdict callers can fold into a request body.
log
upload
Package upload issues short-lived S3 credentials and uploads local image files to the backend's S3 bucket.
Package upload issues short-lived S3 credentials and uploads local image files to the backend's S3 bucket.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL