Altera CLI

A command-line interface companion for Altera. Allows you to create and manage import/export jobs as well as uploading/downloading files from the Shopify admin

Usage

npx altera --help

Adding a Store

The CLI tool supports having multiple stores. These can be managed with npx altera shop. To add a store:

1. Open up Altera in the Shopify admin and go to Settings and create a new API key.
2. Run npx altera shop add. Copy in the shopify domain and API key for your store

Configuration

The CLI stores its configuration in a TOML file located at:

• The path specified in the ALTERA_CONFIG environment variable, if set
• ~/.altera.toml in your home directory (default)

This file contains your store configurations and CLI preferences. Keep this file secret as it contains API keys which have access to Shopify data.

Usage

Download Files from Shopify

$ npx altera files download

Downloading Files
-----------------
URL: https://admin.shopify.com/store/altesting1/apps/altera-dev/job/NZ7JV1/
Output directory: Files_2025-02-20_051744

[x] Preparing file list
[x] Creating local directory
[x] Downloading files (20/20)


20 files saved to ./Files_2025-02-20_051744/
Summary file: ./Files_2025-02-20_051744/Files_2025-02-20_051744.xlsx

You can also filter by file name or file type:

$ npx altera files download --media_type=image  --filename=Main

Uploading Files to Shopify

$ npx altera files upload ~/Desktop/images

Export Data

npx altera export create menus

Check Export Status

npx altera export status <jobId>

List Recent Exports

npx altera export list

For more commands and options, use:

npx altera --help