Skip to main content

Altera CLI Overview

Updated this week

Note: This tool is currently in beta. Please contact us to join the beta program.

The Altera CLI tool is a powerful command-line interface for interacting with your Shopify store through the Altera app. It provides efficient ways to manage data exports and file operations.

Core Commands

Shop Management (shop)

  • shop add [shopDomain] - Connect a new Shopify store to the CLI

  • shop list - View all configured shops

  • shop use [shopDomain] - Switch between different shops

  • shop remove [shopDomain] - Remove a shop configuration

  • shop test [shopDomain] - Test API connection for a specific shop

Export Operations (export)

  • export create <types> - Create a new export job

  • Options:

    • --shop <shopDomain> - Specify the shop domain

    • --nodownload - Create export and return URL without waiting

    • --file-name <fileName> - Specify the output file name

  • export status <jobId> - Check export job status

  • export list - View recent export jobs

File Management (files)

  • files download [localDir] - Download files from Shopify to local folder

  • Options:

    • --filename <filename> - Filter files by filename

    • --media_type <type> - Filter by media type (IMAGE, EXTERNAL_VIDEO, MODEL_3D, VIDEO, FILE)

Job Management (job)

  • job status <jobId> - Get detailed status of any job type

Getting Started

  1. Install the Altera app from the Shopify App Store

  2. Generate an API key from the app's Settings → API keys section

  3. Use shop add to connect your store to the CLI

  4. Start using the commands to manage your store's data and files

Features

  • Batch Operations: Efficiently handle bulk exports

  • File Management: Download and filter store files

  • Progress Tracking: Real-time progress bars for long-running operations

  • Multiple Store Support: Manage multiple Shopify stores from one CLI

Did this answer your question?