Needle Cloud CLI

The official command-line interface for Needle Cloud — deploy websites, optimize 3D assets, and manage your projects from the terminal.

Getting Started

No installation needed — use npx to run commands directly:

npx needle-cloud deploy ./dist --name my-project

Or install globally:

npm install -g needle-cloud

Requirements: Node.js 18 or later.

Commands

npx needle-cloud help              # List all commands
npx needle-cloud help <command>    # Help for a specific command

Core commands:

• deploy — Deploy a website to Needle Cloud
• optimize — Optimize 3D files (glTF, GLB, VRM, FBX, USD) with Draco, KTX2, and Progressive Loading
• login / logout — Authenticate with Needle Cloud
• start — Start the local license server (for editor integrations and CI/CD)

CI/CD

For automated deployments, use an access token:

1. Create a token on your team page with read/write permissions
2. Pass it via --token or the NEEDLE_CLOUD_TOKEN environment variable

npx needle-cloud deploy ./dist --name my-project --token "$NEEDLE_CLOUD_TOKEN"

Or use the official GitHub Action:

- uses: needle-tools/deploy-to-needle-cloud-action@v1
  with:
    token: ${{ secrets.NEEDLE_CLOUD_TOKEN }}
    dir: ./dist
    name: my-project

Links

• Needle Cloud
• Documentation
• Pricing