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. While we do not provide direct API access to Altera, this tool allows you to manage your store's data and files from the command line and to automate your workflows.
Core Commands
Shop Management (shop)
shop add [shopDomain]
- Connect a new Shopify store to the CLIshop list
- View all configured shopsshop use [shopDomain]
- Switch between different shopsshop remove [shopDomain]
- Remove a shop configurationshop test [shopDomain]
- Test API connection for a specific shop
Export Operations (export)
export create <types>
- Create a new export jobOptions:
--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 statusexport list
- View recent export jobs
File Management (files)
files download [localDir]
- Download files from Shopify to local folderOptions:
--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
Install the Altera app from the Shopify App Store
Generate an API key from the app's Settings β API keys section
Use
shop add
to connect your store to the CLIStart 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