Altera CLI

A command-line interface companion for Altera. Allows you to create and manage bulk import/export jobs in the Altera/Matrixify format 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.

Commands

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

Export any Shopify resource type. Output files use the Altera/Matrixify column naming.

npx altera export create menus

Download a Job's Output File

If you've disconnected or want to re-download the output file from a completed job:

npx altera job download <jobId>
npx altera job download <jobId> --output ./exports/
npx altera job download <jobId> --run <runId> --force

Check Job Status

npx altera job status <jobId>

Reference Documentation

Explore available resource types, fields, filters, and operators:

npx altera ref fields              # List all resource types
npx altera ref fields products     # List all fields for products
npx altera ref filters products    # List available filters for products
npx altera ref operators           # List filter operators
npx altera ref metafields          # Metafield column naming and types
npx altera ref taxonomy search shoes  # Search Shopify product taxonomy

Query your shop's configuration:

npx altera ref metafield-definitions     # List metafield definitions
npx altera ref metaobject-definitions    # List metaobject definitions
npx altera ref markets                   # List markets
npx altera ref locations                 # List locations

Add --json to any ref subcommand for machine-readable output.

LLM Integration

If you're using Altera CLI with an AI assistant, run --llm for a condensed reference document:

npx altera --llm

For more commands and options, use:

npx altera --help