Skip to main content

Environment variables

Shoplazza CLI reads the following environment variables.

VariableDescriptionExample
SHOPLAZZA_UATUser Access Token for non-interactive login; auth login uses it when --uat is not passeduat_abc123...
SHOPLAZZA_CLI_PROFILEProfile to use (overridden by --profile)prod-us
SHOPLAZZA_CLI_FORMATPin the default output format (json/pretty/table/ndjson/csv), overriding terminal auto-detection; --format still overrides itjson
SHOPLAZZA_CLI_NO_INTERACTIVEAny non-empty value disables interactive prompts (same as --no-input)1
CIAny non-empty value disables interactive prompts, makes json the default output format, and skips the background update and metadata checkstrue
SHOPLAZZA_CLI_ENVIRONMENTTheme environment from shoplazza.theme.toml for themes push / pull / serve / share (same as -e)staging
SHOPLAZZA_CLI_NO_UPDATE_CHECKDisable the background new-version check1
SHOPLAZZA_CLI_NO_META_UPDATEDisable background API-metadata refreshes1
SHOPLAZZA_CLI_NO_NOTICESet to 1 to drop the _notice block from JSON success envelopes1
SHOPLAZZA_CLI_AUTH_BASE_URLOverride the auth base URL (default https://partners.shoplazza.com)—
SHOPLAZZA_CLI_USER_IDOverride the cli-user-id request header (audit attribution). Defaults to the user ID captured at login; set it when SHOPLAZZA_ACCESS_TOKEN injects a token, which carries no login state—

Usage​

Set these variables for CI/CD pipelines or automated scripts:

shell
export SHOPLAZZA_UAT=your-token

# auth login reads SHOPLAZZA_UAT, so no browser and no --uat flag
shoplazza auth login --store-domain my-store.myshoplaza.com

# Later commands use the stored login
shoplazza products +search --keyword "shirt"

Precedence​

  1. Command-line flags (--uat, --profile, --format) take highest priority
  2. Environment variables (SHOPLAZZA_UAT, SHOPLAZZA_CLI_PROFILE, SHOPLAZZA_CLI_FORMAT) are used when flags are not provided
  3. Stored state is the fallback: the credentials and current profile saved by auth login, and for the output format, terminal auto-detection
On this page