Skip to main content
Reference

StoreFront CLI command reference

Overview​

This page lists every command in the uc-storefront CLI (470 commands in version 0.2.0-beta.9), grouped by area. Each group links to the page that explains when and how to use it. The usage and descriptions come from the CLI's own help. Commands marked "Can require your approval" take --approval and stop for your approval in UltraCart when the change is risky.

For the full options of any command, run it with --help:

uc-storefront sf pages --help
uc-storefront sf comms campaigns create --help

Your agent normally runs these commands for you. You do not need to learn them to use the toolchain, but this list shows exactly what the CLI can do. The same list, with every option, is published as JSON at /cli/commands.json.

Options for every command​

OptionWhat it does
--jsonPrint stable JSON instead of text. Same as --format json.
--format <text|json>Choose text (the default) or JSON output.
--profile <name-or-uuid>Use this merchant profile. Otherwise the CLI uses ULTRACART_PROFILE, the workspace binding, or the current profile.
--workspace <directory>Use this exact workspace folder. File arguments stay relative to the current folder.
--timingsPrint phase timings as a JSON line on standard error. They contain no credentials.
--catalog-dir <directory>Read the element catalog from this folder (or ULTRACART_STOREFRONT_CATALOG_DIR).
-V, --versionPrint the CLI version.

Commands that change your store follow the guarded loop described in Local editing workflow, and some of them wait for your approval in the UltraCart admin. Safety and human approval lists those.

Set up a workspace and sign in​

Explained in Install and set up.

CommandWhat it does
uc-storefront init [directory]Initialize a project and select agent skills (documents: cjson init).
uc-storefront workspaceManage project workspaces.
uc-storefront workspace init [directory]Initialize a project and select agent skills (documents: cjson init).
uc-storefront skillsInstall, refresh, remove, and inspect project agent skills.
uc-storefront skills installInstall or refresh the agent skill for the agents named with --target (claude, codex, gemini, hermes or all).
uc-storefront skills removeRemove the agent skill copies this CLI installed for the agents named with --target.
uc-storefront skills statusRead-only inspection of observed skill copies.
uc-storefront profileManage local merchant profile metadata and workspace selection.
uc-storefront profile listList configured profiles without reading credentials.
uc-storefront profile create <name>Create nonsecret metadata for a merchant profile.
uc-storefront profile show [name-or-uuid]Show a profile selected by name, UUID, environment, workspace, or default.
uc-storefront profile use <name-or-uuid>Set the global current profile.
uc-storefront profile rename <name-or-uuid> <new-name>Rename a profile without changing its UUID or credential key.
uc-storefront profile remove <name-or-uuid>Remove profile metadata and associated credentials.
uc-storefront profile bind <name-or-uuid>Bind a workspace to one profile and optional expected merchant.
uc-storefront profile unbindRemove the nearest workspace binding.
uc-storefront authManage authentication and inspect credential state.
uc-storefront auth loginAuthenticate a merchant profile using interactive OAuth device flow.
uc-storefront auth approve-locationAsk the person who signed in to approve this sign-in's use from the current IP address. Can require your approval.
uc-storefront auth statusReport redacted local credential and profile readiness, including when the sign-in expires.
uc-storefront auth logoutRevoke OAuth refresh token and remove credentials for a merchant profile.
uc-storefront auth keygenFor a person at a terminal: print a new key for the encrypted-file sign-in (never run it where an agent can see the output).

Edit local CJSON files​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront cjsonCreate, inspect, validate, and edit local CJSON documents.
uc-storefront cjson init <file>Create a new root CJSON document.
uc-storefront cjson tree <file>Print the hierarchy with canonical paths and stable IDs.
uc-storefront cjson inspect|get <file> <selector>Read a bounded projection of one widget selected by canonical path or #id.
uc-storefront cjson context <file> <selector>Build a bounded agent packet with widget, schema, placement, and diagnostics.
uc-storefront cjson find <file>Search widgets by type, title, or serialized content.
uc-storefront cjson validate <file>Validate hard tree invariants and lint advisory bundle rules.
uc-storefront cjson apply <file>Apply an ordered JSON plan as one atomic document mutation.
uc-storefront cjson add <file>Create a widget and attach it under a selected parent.
uc-storefront cjson update <file> <selector>Update widget fields with JSON Pointer assignments.
uc-storefront cjson translate <file> <selector> <property>Set one multilingual setting on one widget in any number of languages.
uc-storefront cjson translations <file> [selector]List the multilingual settings with text in a file: which are plain English and which languages each map has.
uc-storefront cjson remove <file> <selector>Delete a selected widget and its subtree.
uc-storefront cjson move <file> <selector>Move a selected widget and its subtree.
uc-storefront tree <file>Print the hierarchy with canonical paths and stable IDs.
uc-storefront inspect|get <file> <selector>Read a bounded projection of one widget selected by canonical path or #id.
uc-storefront context <file> <selector>Build a bounded agent packet with widget, schema, placement, and diagnostics.
uc-storefront find <file>Search widgets by type, title, or serialized content.
uc-storefront validate <file>Validate hard tree invariants and lint advisory bundle rules.
uc-storefront apply <file>Apply an ordered JSON plan as one atomic document mutation.
uc-storefront add <file>Create a widget and attach it under a selected parent.
uc-storefront update <file> <selector>Update widget fields with JSON Pointer assignments.
uc-storefront remove <file> <selector>Delete a selected widget and its subtree.
uc-storefront move <file> <selector>Move a selected widget and its subtree.

Learn elements, guides and recipes​

Explained in Element catalog and guides.

CommandWhat it does
uc-storefront schemaDiscover widget types and their configuration contracts.
uc-storefront schema listList or search widget types.
uc-storefront schema show <widget-type>Show an element's placement and config metadata.
uc-storefront schema children <widget-type>List types documented as children of an element.
uc-storefront schema parents <widget-type>List types documented as required ancestry for an element.
uc-storefront catalogInspect and verify the packaged StoreFront evidence catalog.
uc-storefront catalog infoShow catalog identity, provenance, and package location.
uc-storefront catalog verifyLoad every schema and document and verify the catalog integrity digest.
uc-storefront elementSearch and learn the purpose and behavior of StoreFront elements.
uc-storefront element search <query>Rank elements using type, metadata, authored docs, and config descriptions.
uc-storefront element explain <widget-type>Return a bounded purpose, placement, runtime, and gotchas packet.
uc-storefront element docs <widget-type>Read one element document or a named section with bounded output.
uc-storefront guideSearch and read the packaged agent guide, tutorials, and recipes.
uc-storefront guide listList packaged guides.
uc-storefront guide search <query>Search across the agent guide, tutorials, and recipes.
uc-storefront guide show <guide-id>Read a packaged guide with bounded output.
uc-storefront recipeCapture native widget subtrees and instantiate local or built-in recipes.
uc-storefront recipe listList built-ins and top-level *.recipe.json files from ./recipes or --directory.
uc-storefront recipe search <query>Find recipes by name, description and tags.
uc-storefront recipe example [name]Print a built-in recipe (native-editorial by default, or experiment-ab).
uc-storefront recipe capture <file> <selector>Save a selected native widget and its children as a new local recipe file.
uc-storefront recipe instantiate <recipe-file> <file>Emit an ordinary apply plan from a local recipe or a built-in (builtin:native-editorial, builtin:experiment-ab).

Query the data warehouse​

Explained in Analytics and tracking.

CommandWhat it does
uc-storefront warehouseRun a bounded, audited read against the merchant's BigQuery warehouse.
uc-storefront warehouse query <sql>Dry-run, check the ceiling and the dataset boundary, then run the query.

Report documentation gaps​

Explained in Troubleshooting.

CommandWhat it does
uc-storefront docsCapture and review documentation gaps locally, and submit them to UltraCart.
uc-storefront docs gapCapture and review merchant-owned reports locally, with no network or sign-in.
uc-storefront docs gap captureSave a new report locally.
uc-storefront docs gap review <file>Read a report without changing it.
uc-storefront docs gap submit <file>Send a reviewed report to UltraCart, whose staff review it.
uc-storefront docs gap status <report_id>Where a submitted report stands: received, accepted, declined or fixed (read only).

StoreFront commands (sf)​

The sf commands read and change a storefront on UltraCart. They need a signed-in profile bound to the workspace (see Connect your store).

404 handling​

Explained in Redirects and 404s.

CommandWhat it does
uc-storefront sf not-foundThe paths shoppers asked for that answered 404, and the storefront's 404 page.
uc-storefront sf not-found listList the top missed paths (the default when no subcommand is given).
uc-storefront sf not-found show <id>One missed path with its recent hits: time, linking host, user agent and bot flag.
uc-storefront sf not-found ignore <id>Hide a missed path from the list and stop counting it, such as scanner noise.
uc-storefront sf not-found fixed <id>Mark a missed path fixed, for one fixed by creating the page rather than a redirect.
uc-storefront sf not-found remove <id>Remove a missed path from the log.
uc-storefront sf not-found export <file>Write up to 5,000 open missed paths, most hits first, as a redirect import CSV with the target blank to fill in.
uc-storefront sf not-found summaryThe 404 trend the admin charts: hits per day for 30 and 7 days and per hour for 24 hours, plus the busiest new paths.
uc-storefront sf not-found pageThe site_404.vm the active theme renders for a 404, whether it exists, and its status.

Approvals​

Explained in Safety and approvals.

CommandWhat it does
uc-storefront sf approvalsApprovals the signed-in person gives in the UltraCart admin for deletes (list, get, wait, cancel).
uc-storefront sf approvals listThis sign-in's approvals from the last 24 hours, newest first.
uc-storefront sf approvals get <id>One approval: its status, what it covers, and its outcome once used.
uc-storefront sf approvals wait <id>Wait for the person to decide.
uc-storefront sf approvals cancel <id>Withdraw a pending request and free its slot (5 pending per sign-in).

Blog posts​

Explained in Blog posts.

CommandWhat it does
uc-storefront sf blog-postsFind, read, write and illustrate the storefront's blog posts.
uc-storefront sf blog-posts listList blog posts, newest first.
uc-storefront sf blog-posts get <oid>Read one blog post in full: body, excerpt, tags, images and where it shows.
uc-storefront sf blog-posts create <file>Create a blog post from a JSON file.
uc-storefront sf blog-posts update <oid> <file>Change a blog post: only the fields in the file change.
uc-storefront sf blog-posts delete <oid>Take a blog post off every page and delete it once the signed-in person approves. Can require your approval.
uc-storefront sf blog-posts imagesAttach or detach a blog post's images.
uc-storefront sf blog-posts images attach <oid> <image>Upload a local image and attach it to the post.
uc-storefront sf blog-posts images detach <oid>Remove an image from the post.

Explained in Menus search and site settings.

CommandWhat it does
uc-storefront sf searchRead and change the storefront's catalog search settings.
uc-storefront sf search facetsRead and change faceted search: which facets the facet sidebar offers, their headings and the Cost price points.
uc-storefront sf search facets getList each facet with its heading and whether it's on, the Cost price points, and the hash for 'set --if-match'.
uc-storefront sf search facets setTurn facets on or off, rename their headings or set the Cost price points, in one partial update.

Communications​

Explained in Communications.

CommandWhat it does
uc-storefront sf commsThe account's Twilio account, sending domains and plan, the storefront's Communications settings, templates and providers, its campaigns, flows, lists and segments, their statistics, rendering an email or proofing a...
uc-storefront sf comms twilioThe account's Twilio account, for SMS and the phone system (get, create, update, delete).
uc-storefront sf comms twilio getThe Twilio account, with the auth token masked.
uc-storefront sf comms twilio createConnect the Twilio account: its SID and an auth token from a handle or @request.
uc-storefront sf comms twilio updateChange the Twilio account: a new auth token, a new account (SID and token), or its phone numbers.
uc-storefront sf comms twilio deleteRemove the Twilio account from UltraCart once the signed-in person approves. Can require your approval.
uc-storefront sf comms domainsThe account's sending domains (list, get, status, create, update, delete).
uc-storefront sf comms domains listEvery sending domain, with its provider, verification and DNS records.
uc-storefront sf comms domains get <domain>One sending domain as stored.
uc-storefront sf comms domains status <domain>Check an amazon domain's DNS records again with Amazon SES (restarts a verification that failed).
uc-storefront sf comms domains create <domain>Add a sending domain: amazon (publish the DNS records it returns) or mailgun (with its API key).
uc-storefront sf comms domains update <domain>Replace a mailgun domain's API key.
uc-storefront sf comms domains delete <domain>Remove a sending domain from UltraCart once the signed-in person approves. Can require your approval.
uc-storefront sf comms campaignsCampaigns, each with its emails and postcards in step order (list, get, create, update, archive, unarchive, clone).
uc-storefront sf comms campaigns listThe storefront's campaigns, newest first, with their emails and postcards.
uc-storefront sf comms campaigns get <campaign_uuid>One campaign, the same as its list entry, with its emails and postcards.
uc-storefront sf comms campaigns createCreate a draft campaign with no emails yet.
uc-storefront sf comms campaigns update <campaign_uuid>Change a campaign.
uc-storefront sf comms campaigns archive <campaign_uuid>Archive a campaign.
uc-storefront sf comms campaigns unarchive <campaign_uuid>Unarchive a campaign.
uc-storefront sf comms campaigns clone <campaign_uuid>Copy a campaign on the same storefront, with its own copies of its emails and postcards, as a draft.
uc-storefront sf comms campaigns foldersCampaign folders: list them, read one with what it holds, create, rename or delete one (list, get, create, update, delete).
uc-storefront sf comms campaigns folders listThe storefront's campaign folders by name, each with how many campaigns it holds.
uc-storefront sf comms campaigns folders get <folder_uuid>One campaign folder, with the name and uuid of each campaign in it.
uc-storefront sf comms campaigns folders createCreate an empty campaign folder.
uc-storefront sf comms campaigns folders update <folder_uuid>Rename a campaign folder.
uc-storefront sf comms campaigns folders delete <folder_uuid>Delete a campaign folder.
uc-storefront sf comms flowsFlows, each with its trigger and its emails and postcards in step order (list, get, create, update, archive, unarchive, clone, activate, deactivate).
uc-storefront sf comms flows listThe storefront's flows, newest first, with their emails and postcards.
uc-storefront sf comms flows get <flow_uuid>One flow, the same as its list entry, with its emails and postcards.
uc-storefront sf comms flows createCreate a draft flow with no steps yet.
uc-storefront sf comms flows update <flow_uuid>Change a flow.
uc-storefront sf comms flows archive <flow_uuid>Archive a flow.
uc-storefront sf comms flows unarchive <flow_uuid>Unarchive a flow.
uc-storefront sf comms flows clone <flow_uuid>Copy a flow on the same storefront, with its own copies of its emails and postcards, as a draft.
uc-storefront sf comms flows foldersFlow folders: list them, read one with what it holds, create, rename or delete one (list, get, create, update, delete).
uc-storefront sf comms flows folders listThe storefront's flow folders by name, each with how many flows it holds.
uc-storefront sf comms flows folders get <folder_uuid>One flow folder, with the name and uuid of each flow in it.
uc-storefront sf comms flows folders createCreate an empty flow folder.
uc-storefront sf comms flows folders update <folder_uuid>Rename a flow folder.
uc-storefront sf comms flows folders delete <folder_uuid>Delete a flow folder.
uc-storefront sf comms flows backfill <flow_uuid>Enroll and mail past customers who would have met a live flow's trigger. Can require your approval.
uc-storefront sf comms flows activate <flow_uuid>Turn a flow on: customers who trigger it from now on are enrolled and get its emails.
uc-storefront sf comms flows deactivate <flow_uuid>Turn a flow off: no new customers are enrolled.
uc-storefront sf comms listsEmail lists, for a campaign's audience or a list trigger: list them, read one with who uses it, create one, change its name, folder or public settings, or archive it (list, get, create, update, archive).
uc-storefront sf comms lists listThe storefront's email lists by name: uuid, name and member count, never the members.
uc-storefront sf comms lists get <list_uuid>One list: name, folder, member count, public settings, and the campaigns and flows that use it.
uc-storefront sf comms lists createCreate an empty list.
uc-storefront sf comms lists update <list_uuid>Change a list's name, folder or public settings.
uc-storefront sf comms lists archive <list_uuid>Archive a list, keeping its members.
uc-storefront sf comms lists members <list_uuid>Who is on the list, a page at a time: customer uuid, email (masked) and when they joined.
uc-storefront sf comms segmentsCustomer segments, for a campaign's audience or a segment trigger: list them, read one with its rule, create one, change its name, rule or folder, archive it, read its members, or look up what a rule function takes...
uc-storefront sf comms segments listThe storefront's segments by name: uuid, name and member count at the last rebuild, never the members or the rule.
uc-storefront sf comms segments get <segment_uuid>One segment: name, folder, rule, member count at the last rebuild, whether a rebuild is due, and the campaigns and flows that use it.
uc-storefront sf comms segments createCreate a segment from a name and a rule.
uc-storefront sf comms segments update <segment_uuid>Change a segment's name, rule or folder. Can require your approval.
uc-storefront sf comms segments archive <segment_uuid>Archive a segment.
uc-storefront sf comms segments members <segment_uuid>Who is in the segment, a page at a time: customer uuid, email (masked) and when they joined.
uc-storefront sf comms segments functionsThe rule functions a segment or step filter can use: each function's fields and, where the admin picks from a fixed list, the values it saves (no sign-in needed).
uc-storefront sf comms foldersList and segment folders: list them, read one with what it holds, create, rename or delete one (list, get, create, update, delete).
uc-storefront sf comms folders listThe storefront's list and segment folders by name, each with how many lists and segments it holds.
uc-storefront sf comms folders get <folder_uuid>One folder, with the name and uuid of each list and segment in it.
uc-storefront sf comms folders createCreate an empty folder.
uc-storefront sf comms folders update <folder_uuid>Rename a folder.
uc-storefront sf comms folders delete <folder_uuid>Delete a folder.
uc-storefront sf comms sequencesA campaign's or flow's steps, as a tree, one step's dispatch log and counts, one step's settings or filter, new email, wait, split, condition and postcard steps, moving and removing a step (get, dispatch-logs,...
uc-storefront sf comms sequences get <sequence_uuid>A campaign's or flow's steps in order: each step's type, label, settings and audience filter, the emails, postcard, lists or items it names, and the branches of a condition, split or InboxGeek step.
uc-storefront sf comms sequences dispatch-logs <sequence_uuid>Why a step sent, skipped or ended each customer who reached it, newest first, with the step's counts (read only).
uc-storefront sf comms sequences set-config <sequence_uuid>Change one step's settings, and nothing else about the step or the sequence. Can require your approval.
uc-storefront sf comms sequences set-filter <sequence_uuid>Change one step's audience filter, and nothing else about the step or the sequence.
uc-storefront sf comms sequences add-email <sequence_uuid>Add an email step, with its new email, after a step, first on one side of a condition, split or InboxGeek step, or as the first step of a new campaign or flow.
uc-storefront sf comms sequences add-wait <sequence_uuid>Add a wait step after a step, first on one side of a condition, split or InboxGeek step, or as the first step of a new campaign or flow.
uc-storefront sf comms sequences add-split <sequence_uuid>Add a split, which sends a share of customers left and the rest right, after a step, first on one side of a condition, split or InboxGeek step, or as the first step of a new campaign or flow.
uc-storefront sf comms sequences add-condition <sequence_uuid>Add a condition, which sends customers matching a rule down yes and the rest down no, after a step, first on one side of a condition, split or InboxGeek step, or as the first step of a new campaign or flow.
uc-storefront sf comms sequences add-postcard <sequence_uuid>Add a postcard step, off, with its postcard's default front and back, after a step, first on one side of a condition, split or InboxGeek step, or as the first step of a new campaign or flow.
uc-storefront sf comms sequences move-step <sequence_uuid>Move one step to after another step, first on one side of a condition, split or InboxGeek step, or first in the sequence, keeping its email or postcard. Can require your approval.
uc-storefront sf comms sequences remove-step <sequence_uuid>Remove one step, archiving the email or postcard it sent. Can require your approval.
uc-storefront sf comms sequences stats <sequence_uuid>A campaign's or flow's statistics: all time overall, and each step's (each variant and branch) over --days (read only).
uc-storefront sf comms sequences test-sms <sequence_uuid>Send one test of an SMS step to a user's cell phone.
uc-storefront sf comms emailsFlow and campaign emails (get, update, request-review, render, clicks, test).
uc-storefront sf comms emails get <email_uuid>A flow or campaign email's subject and preview text, with its hash_sha256, whether it is live, and its review state.
uc-storefront sf comms emails update <email_uuid>Change a flow or campaign email's subject or preview text.
uc-storefront sf comms emails request-review <email_uuid>Ask for a content review of an email: the review runs in the background and the signed-in person gets the ruling.
uc-storefront sf comms emails render <email_uuid>Render a flow or campaign email, saved or a draft, as a test send would, and send nothing.
uc-storefront sf comms emails clicks <email_uuid>The links clicked in one email of a campaign or flow, most clicked first (read only).
uc-storefront sf comms emails test <email_uuid>Send one test of a campaign or flow email to a user on the account.
uc-storefront sf comms transactionalTransactional emails, such as the order receipt (list, get, update, render).
uc-storefront sf comms transactional get <file_name>One transactional email's subject, delivery options and sender, with the storefronts that share the sender and the hash_sha256 for --if-match.
uc-storefront sf comms transactional update <file_name>Change a transactional email's subject, delivery options or sender. Can require your approval.
uc-storefront sf comms transactional listThe storefront's transactional emails: name, template file_name, text_file_name when the email has a text template, and body_file_name and body_path when its theme has a body container.
uc-storefront sf comms transactional render <file_name>Render a transactional email (a file_name from list, such as receipt_html.vm), saved or a draft, and send nothing.
uc-storefront sf comms libraryThe code library the admin's 'start from library' uses (not 'sf library', the Visual Builder element library): emails, add-email, get.
uc-storefront sf comms library emailsCode-library email items this storefront can start an email from, by title, with their subject, preview text and source (owned, shared or public).
uc-storefront sf comms library add-emailSave a reusable email design (body, subject, preview text) to the account's private code library, for the admin's new-email 'start from library' picker.
uc-storefront sf comms library get <library_item_oid>One code-library email item: title, subject, preview text, source and files, with its body CJSON.
uc-storefront sf comms postcardsFlow and campaign postcards (tracking, pull, push, proof, mail-test).
uc-storefront sf comms postcards tracking <postcard_uuid>Every card mailed for a postcard, newest first: status, cost, dates and the order it converted to.
uc-storefront sf comms postcards pull <dir>Pull a postcard's front and back, with postcard.json, into an existing directory that holds no pull.
uc-storefront sf comms postcards push <dir>Push a pulled postcard: both sides checked first, then the front, then the back.
uc-storefront sf comms postcards proof <sequence_uuid>Proof a postcard step as it would print: both sides' HTML, and the print vendor's PNGs and proof PDF from a dry run.
uc-storefront sf comms postcards mail-test <sequence_uuid>Print and mail one test postcard at the account's cost. Can require your approval.
uc-storefront sf comms settingsThe storefront's Communications settings: postcard return address, default marketing and transactional senders, and SMS number (get, set).
uc-storefront sf comms settings getThe postcard return address, default senders and SMS number, with notes on what each drives and the hash_sha256 for --if-match.
uc-storefront sf comms settings setChange the postcard return address, a default sender or the SMS number. Can require your approval.
uc-storefront sf comms planThe account's Communications plan: limits, what was sent against them, and whether sending is paused (read only).
uc-storefront sf comms templatesThe email templates a new email can start from (list, get).
uc-storefront sf comms templates listEvery template a new email can start from: source, email_template_oid, path, name, description and trigger_type.
uc-storefront sf comms templates get <email_template_oid>One of the account's templates with its container CJSON.
uc-storefront sf comms providersOutside email providers and their lists, and importing those lists (list, import).
uc-storefront sf comms providers listEach provider, whether it's connected, its lists with their ids, and whether the account may import.
uc-storefront sf comms providers importImport a provider's lists as new lists, subscribing every member in the background. Can require your approval.
uc-storefront sf comms statsCommunications statistics across flows and campaigns (dashboard).
uc-storefront sf comms stats dashboardEach flow's and campaign's statistics over --days, and the last 31 days' daily totals (read only).
uc-storefront sf comms rulerEvent Ruler patterns for Is in BigQuery segment rules (validate).
uc-storefront sf comms ruler validate <file>Check that the Event Ruler pattern in a file compiles, before it goes into an Is in BigQuery segment rule.
uc-storefront sf comms unreferencedThe storefront's emails and postcards that no step names, so nothing sends them (read only).
uc-storefront sf comms lookup <uuid>Which storefront a campaign, flow, sequence, step, email, postcard, list or segment uuid is on, its owner, and the command that reads it (read only).

Containers​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf containersRead and replace the containers that are stored as rows rather than files.
uc-storefront sf containers listList the item containers on the account.
uc-storefront sf containers pull <file>Write a container and its baseline to a new local file.
uc-storefront sf containers push <file>Replace a container with the file you pulled (it needs the .sf.json baseline beside it), or create one with --create.
uc-storefront sf containers versionsList a container's history in the server's order.
uc-storefront sf containers version <history-oid>Read one earlier version's CJSON, and what a revert to it would change, without reverting.
uc-storefront sf containers revertRestore a historical version.

Elements​

Explained in Element catalog and guides.

CommandWhat it does
uc-storefront sf elementsRead the server's element vocabulary, config schemas and Markdown field cards.
uc-storefront sf elements listList server element types and schema/doc availability flags.
uc-storefront sf elements get <type>Read a server config schema (JSON string) and Markdown doc.

Events​

Explained in Safety and approvals.

CommandWhat it does
uc-storefront sf eventsWatch for changes this sign-in waits on (approvals decided), instead of polling.
uc-storefront sf events watchPrint one JSON event per line as they happen.

Experiments​

Explained in Experiments.

CommandWhat it does
uc-storefront sf experimentsStart, watch and end StoreFront Experiments on pages and between pages.
uc-storefront sf experiments objectivesList the objectives an experiment can optimize.
uc-storefront sf experiments listList experiments with their statistics.
uc-storefront sf experiments get <experimentOid>Read one experiment's statistics, with an assessment of whether to act.
uc-storefront sf experiments start-pageStart the experiment element saved in a page body. Can require your approval.
uc-storefront sf experiments start-url <file>Start a split between existing pages from a JSON spec. Can require your approval.
uc-storefront sf experiments pause <experimentOid>Stop sending new visitors to a variation (not variation 0).
uc-storefront sf experiments resume <experimentOid>Send new visitors to a paused variation again.
uc-storefront sf experiments end <experimentOid>End an experiment with a winner, or without one. Can require your approval.

Files​

Explained in Files and assets.

CommandWhat it does
uc-storefront sf filesList, read, write, delete, upload, and restore storefront files.
uc-storefront sf files validate <local>Validate theme JSON offline against the bundled partial contract.
uc-storefront sf files upload <local>Upload a matching image (.jpg, .jpeg, .png, .gif, .webp, .avif, .svg), video (.mp4, .webm, .mov), font (.woff, .woff2, .ttf, .otf, .eot) or .pdf asset.
uc-storefront sf files put <local>Write a local .json or .css file, such as a SurveyJS survey definition or override.css, or a reviewed and approved .js, .vm or .html. Can require your approval.
uc-storefront sf files delete <path>Delete one storefront file with a current If-Match hash. Can require your approval.
uc-storefront sf files list [path]List one storefront directory.
uc-storefront sf files get <path>Read the current or an earlier version of a text storefront file.
uc-storefront sf files versions <path>List a file's version history, newest first.
uc-storefront sf files searchFind storefront files by name, contents or state, on the server.
uc-storefront sf files download <path>Save a storefront file's exact bytes to a new local file: any type, from any theme.
uc-storefront sf files revert <path>Restore an earlier version of a file. Can require your approval.

Image sizes​

Explained in Files and assets.

CommandWhat it does
uc-storefront sf sizesMeasure and manage local responsive-image widths.
uc-storefront sf sizes measure <file>Measure one local container in a temporary preview and write a new sizes plan.
uc-storefront sf sizes apply <file>Apply a source-bound sizes plan to one local file.
uc-storefront sf sizes clear <file> <selector>Clear only the selected widget's measured sizes in a local file.

Items​

Explained in Items.

CommandWhat it does
uc-storefront sf itemsRead and change the item content a StoreFront element renders.
uc-storefront sf items getRead an item's attributes, images, title, description, search metadata and tags (item, order and customer.
uc-storefront sf items attributes <file>Apply a partial attribute update from JSON.
uc-storefront sf items content <file>Change the item's title or long description.
uc-storefront sf items seo <file>Change the item's search metadata.
uc-storefront sf items remove-attribute <name>Remove one attribute that no template declares from the item.
uc-storefront sf items set-attributesChange attributes across many items from a file: a dry run first, then --apply --live writes what it checked. Can require your approval.
uc-storefront sf items restore-attributes <backup>Put values back from a 'sf items set-attributes' backup: a dry run first, then --apply --live. Can require your approval.
uc-storefront sf items pricingRead or change what an item charges: price, sale, MSRP and retail volume pricing.
uc-storefront sf items pricing getRead the item's price, sale, MSRP and volume pricing, with the hash to change it.
uc-storefront sf items pricing setChange the item's pricing once the signed-in person approves. Can require your approval.
uc-storefront sf items preorderRead or change whether an item, or its variations, can be bought before it's in stock, and its expected date.
uc-storefront sf items preorder getRead the item's pre-order flag, ETA and what shoppers see, with the hash to change them.
uc-storefront sf items preorder setTurn pre-order on or off, or set or clear the ETA, for an item or some of its variations. Can require your approval.
uc-storefront sf items variationsRead or change a parent item's variations: its axes (Size), their options (2T, 3T) and the child item each combination sells.
uc-storefront sf items variations getRead the item's axes and options in order (the default marked), each combination with its child, unfilled combinations and the hash.
uc-storefront sf items variations setChange the item's variations with an ordered list of changes, checked as a whole before any is saved. Can require your approval.
uc-storefront sf items create-childCreate a child item from a parent, to sell as one of its variations: copies cost, weight, dimensions, folder and description.
uc-storefront sf items pagesList the pages an item is on in this storefront, with its default (canonical) page marked and hidden pages noted.
uc-storefront sf items set-default-pageMove items' default (canonical) page to another page each is already on: a dry run and plan first, then an approved apply. Can require your approval.
uc-storefront sf items relatedRead or replace an item's related items.
uc-storefront sf items related getRead the item's related items, with the hash to change them.
uc-storefront sf items related set [items...]Replace the item's own related items with these merchant item IDs (ID or ID:addon / ID:complementary).
uc-storefront sf items imagesAttach, detach or describe the item's images.
uc-storefront sf items images attach <path>Attach an already uploaded raster image to the item.
uc-storefront sf items images detachDetach an item image.
uc-storefront sf items images describeChange one item image's description (alt text) in place.

Languages and translations​

Explained in Languages.

CommandWhat it does
uc-storefront sf i18nA storefront's languages, its built-in messages, where translations come from, and its glossary.
uc-storefront sf i18n languagesThe storefront's languages, their codes and aliases, and the cost of enabling one more.
uc-storefront sf i18n languages listList the languages (the default when no subcommand is given).
uc-storefront sf i18n languages enable <code>Turn a language on: it is served and machine translated, which is billed.
uc-storefront sf i18n languages disable <code>Stop serving a language.
uc-storefront sf i18n messagesSearch the built-in messages: the system text templates render by key, such as checkout labels.
uc-storefront sf i18n messages listSearch the messages (the default when no subcommand is given).
uc-storefront sf i18n messages get <key>Read one message, with the hash a set or reset sends back.
uc-storefront sf i18n messages set <key>Change one message in any number of its languages.
uc-storefront sf i18n messages reset <key>Put a message back to the template's text.
uc-storefront sf i18n machine [file] [selector] [property]Where each language's text comes from for one widget setting or message: hand, machine, pending or none.
uc-storefront sf i18n glossaryRead the storefront's translation glossary: terms not to translate, required translations, tone, words to avoid.
uc-storefront sf i18n glossary getRead the glossary (the default when no subcommand is given).
uc-storefront sf i18n glossary put <file>Replace the storefront's glossary with a markdown file, up to 64 KB.
uc-storefront sf i18n glossary init <file>Write the starter glossary template to a new local file.

Library​

Explained in Library and reusable content.

CommandWhat it does
uc-storefront sf libraryFind, save, share and install reusable fragments (one widget and its children) in the element library.
uc-storefront sf library taxonomyThe fixed tag list: purpose, section, industry and style, each tag with what it is for.
uc-storefront sf library search [query]Search the library by name, description and tags.
uc-storefront sf library get <oid>Read one entry: its scan first, then its fragment, tags and parameters.
uc-storefront sf library history <oid>The entry's published revisions, newest first, with their release notes.
uc-storefront sf library addSave a widget and its children from a local CJSON file as a new private library entry.
uc-storefront sf library update <oid>Change your draft: only what the flags name changes.
uc-storefront sf library captureScreenshot one widget as a signed-out shopper sees it, in a local headless Chrome, to a new PNG.
uc-storefront sf library screenshot <oid>Set your entry's screenshot from a PNG, or clear it.
uc-storefront sf library publish <oid>Freeze your draft as a published revision your linked accounts can see, or with --public every merchant.
uc-storefront sf library unpublish <oid>Narrow who sees your published revisions.
uc-storefront sf library share-targetsYour linked accounts: the only merchants an entry can be shared with.
uc-storefront sf library share <oid>Share your published entry with one linked account.
uc-storefront sf library unshare <oid>Stop one linked account installing your entry.
uc-storefront sf library install <oid>Copy an entry's files into this storefront and hand back its fragment to place.
uc-storefront sf library installsThe entries installed on this storefront, with the revision installed and the latest.
uc-storefront sf library duplicate <oid>Copy an entry you can see into a new private draft you own.
uc-storefront sf library delete <oid>Delete your entry, or retire it when it was published, shared or installed.
uc-storefront sf library favorite <oid>Bookmark an entry for yourself, or remove the bookmark.

Locate​

Explained in Analytics and tracking.

CommandWhat it does
uc-storefront sf locate <targets...>Resolve a heatmap selector or widget id, on one page, to the container file and widget it names.

Explained in Menus search and site settings.

CommandWhat it does
uc-storefront sf menusRead and replace a storefront's store menus, which are what a menu element renders.
uc-storefront sf menus listList the store menus on a storefront, without their entries.
uc-storefront sf menus pull <code>Write a menu and its baseline to a new local file.
uc-storefront sf menus push <file>Replace a store menu with a local file.

Pages​

Explained in Pages and themes.

CommandWhat it does
uc-storefront sf pagesRead and update catalog page attributes and images used by pageattribute/pageimage.
uc-storefront sf pages getRead page attributes, image slots and template declaration metadata.
uc-storefront sf pages attributes <file>Apply a partial attribute update from JSON.
uc-storefront sf pages refresh <url>Drop one page's cached copy so the next request renders it fresh.
uc-storefront sf pages imagesAttach or detach the page's default or coded image.
uc-storefront sf pages images attach <filename>Attach a raster image already uploaded into the page folder.
uc-storefront sf pages images detachDetach a page image.
uc-storefront sf pages listList every page with its settings, or the pages under one path.
uc-storefront sf pages templatesList the active theme's templates and what each can render.
uc-storefront sf pages create <path>Create a page under an existing parent page.
uc-storefront sf pages settings <file>Change page settings from a JSON object.
uc-storefront sf pages move <path> <new_path>Move or rename a page, with its sub-pages, items and folder, once the signed-in person approves. Can require your approval.
uc-storefront sf pages duplicate <source> <target>Copy a page, with its body, attributes, images and assignments, to a new path.
uc-storefront sf pages itemsRead, add or remove the items assigned to a page.
uc-storefront sf pages items getRead the page's items with their sort order and url part.
uc-storefront sf pages items add <file>Assign items from {"items":[{"item_id":"SKU-1","url_part":"sku-1"}]}.
uc-storefront sf pages items remove <itemIds...>Take items off the page.
uc-storefront sf pages blog-postsRead, add or remove the blog posts assigned to a page.
uc-storefront sf pages blog-posts getRead the blog posts the page shows.
uc-storefront sf pages blog-posts add <oids...>Assign blog posts by oid.
uc-storefront sf pages blog-posts remove <oids...>Take blog posts off the page.
uc-storefront sf pages selectorsRead or replace the selectors that choose a page's items and blog posts.
uc-storefront sf pages selectors getRead the item and blog post selectors.
uc-storefront sf pages selectors set <file>Replace selector sets from JSON.

Previews​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf previewStage theme containers in a preview session and open it in any browser.
uc-storefront sf preview diffCompare full-page live and staged screenshots before publishing.
uc-storefront sf preview startOpen a preview session.
uc-storefront sf preview stageReplace a preview session's containers with local theme files, page bodies and item containers.
uc-storefront sf preview openPrint a single-use link that opens the storefront in preview in any browser.
uc-storefront sf preview endDelete a preview session before it expires.

Pull​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf pull <path>Read container CJSON into a new local file with its hash and baseline.

Push​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf push <file>Validate and write a whole container CJSON document using its saved baseline.

Redirects​

Explained in Redirects and 404s.

CommandWhat it does
uc-storefront sf redirectsThe storefront's redirect rules: real 301 redirects for moved or removed URLs.
uc-storefront sf redirects listList the rules (the default when no subcommand is given), with the count and the limit.
uc-storefront sf redirects get <id>Read one rule, with the hash an update or delete sends back.
uc-storefront sf redirects resolve [path]What a shopper gets for a path, or for every path in a file: each redirect followed, the final path and status, and what it lands on.
uc-storefront sf redirects export <file>Write every rule to a CSV: the import format (the default), or the admin's own four columns with --admin.
uc-storefront sf redirects add <source> <target>Create one 301 redirect, live at once.
uc-storefront sf redirects update <id>Change one rule's source, target, note or sitemap listing, or make an admin rule a 301.
uc-storefront sf redirects delete [id]Delete one rule, or many with --ids: a dry run first, then --apply --live deletes what it checked. Can require your approval.
uc-storefront sf redirects restore <backup>Put rules back from a 'sf redirects delete --ids' backup: a dry run first, then --apply --live.
uc-storefront sf redirects import <csv>Migrate rules from a CSV: a dry run first, then --apply --live writes exactly what it checked.

Render​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf render <file> [selector]Render one local CJSON node against a remote storefront theme without writing.

Render logs​

Explained in Analytics and tracking.

CommandWhat it does
uc-storefront sf logsRead the storefront's server render logs, the ones the Developer Tools panel shows.
uc-storefront sf logs listList recent render logs, newest first, with error and warning counts but no log text.
uc-storefront sf logs get <log_id>Read one render's log lines at or above a level.

Reports​

Explained in Snapshots and reports.

CommandWhat it does
uc-storefront sf report <snapshot>Write a shareable PDF of a storefront: its pages, menus and redirects, with desktop and mobile screenshots.

Screen recordings​

Explained in Analytics and tracking.

CommandWhat it does
uc-storefront sf recordingsCheck or switch screen recording, read a visitor's recording and replay chosen page views on this machine.
uc-storefront sf recordings show <screen_recording_uuid>Show a recorded session and its page views, with named events such as rage clicks and script errors.
uc-storefront sf recordings render <screen_recording_uuid>Fetch chosen page views' replay events and render a timeline, frames and optionally video locally.
uc-storefront sf recordings statusSay whether screen recording is on for the storefront, with its trial, cost and session counts.
uc-storefront sf recordings enableStart recording real shoppers' sessions on the storefront, only when the merchant asks.
uc-storefront sf recordings disableStop recording shoppers' sessions on the storefront.

Secrets​

Explained in Safety and approvals.

CommandWhat it does
uc-storefront sf secretsCredentials a person enters in the UltraCart admin, used through handles (kinds, request, get, wait, list, cancel, revoke).
uc-storefront sf secrets kindsThe secret fields (sinks) a handle can be written to, and what each kind of value looks like.
uc-storefront sf secrets requestAsk a person to enter one or more credentials.
uc-storefront sf secrets get <id>One secret request: its status and each handle's status and fingerprint (never a value).
uc-storefront sf secrets wait <id>Wait for the person to enter the values.
uc-storefront sf secrets listThis sign-in's secret requests from the last 24 hours, newest first (without handles).
uc-storefront sf secrets cancel <id>Withdraw a request nobody has filled in yet, with its handles.
uc-storefront sf secrets revoke <id>Revoke a filled-in request's handles that no write has used, so their values can never be written.

Site settings​

Explained in Menus search and site settings.

CommandWhat it does
uc-storefront sf siteRead and update the storefront's site attributes used by siteattribute and $site.attr, its search engine settings, and read its sitemaps.
uc-storefront sf site getRead every site attribute with its type, writability and theme usage.
uc-storefront sf site attributes <file>Apply a partial site attribute update from JSON.
uc-storefront sf site seoRead the search engine settings: Canonical Links, Schema.org and Prevent Indexing, the default meta description and keywords, and the hash for seo-set.
uc-storefront sf site seo-setTurn Canonical Links, Schema.org or Prevent Indexing on or off. Can require your approval.
uc-storefront sf site sitemapsRead the storefront's sitemap URLs, their child files and build times, and robots.txt's Sitemap lines.

Snapshots​

Explained in Snapshots and reports.

CommandWhat it does
uc-storefront sf snapshotRecord how a storefront is laid out at handoff, and compare it with the live site later.
uc-storefront sf snapshot take <dir>Write a read-only snapshot of a storefront's layout to a new or empty directory.
uc-storefront sf snapshot diff <old> [new]Compare a snapshot with a newer one or with the live storefront.

Storefronts​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf storefrontsList storefronts available to the authenticated profile.

Surveys​

Explained in Surveys.

CommandWhat it does
uc-storefront sf surveysCheck SurveyJS survey definition files offline.
uc-storefront sf surveys validate <file>Validate a SurveyJS survey JSON file against the SurveyJS version the storefront loads, as the catalog declares it.

Templates​

Explained in Pages and themes.

CommandWhat it does
uc-storefront sf templateFind a page's template, copy one under a new name, or edit literal container parse lines in an explicitly selected template.
uc-storefront sf template findShow the templates a page is set to use and their theme file paths.
uc-storefront sf template resolve <name>Show which file a template name renders, from the storefront's own template search.
uc-storefront sf template wireWire a container parse. Can require your approval.
uc-storefront sf template unwireUnwire a container parse. Can require your approval.
uc-storefront sf template moveMove a container parse. Can require your approval.
uc-storefront sf template createCopy a page template under a new name, so one page can have its own layout. Can require your approval.
uc-storefront sf template deleteDelete an unused page template the active theme itself holds, such as one 'sf template create' made. Can require your approval.

Test orders​

Explained in Checkout and my account.

CommandWhat it does
uc-storefront sf ordersFind test orders to render the order pages with.
uc-storefront sf orders test-ordersList the account's test orders, newest first, from the whole order history (a just-placed order can take a moment to appear).

Theme attributes​

Explained in Pages and themes.

CommandWhat it does
uc-storefront sf theme-attributesRead and change a theme's applied colours, fonts and settings.
uc-storefront sf theme-attributes getList a theme's colour and font slots with value, default and description (--all for every slot).
uc-storefront sf theme-attributes setChange one or more slots in a single partial update.

Themes​

Explained in Pages and themes.

CommandWhat it does
uc-storefront sf themesList a storefront's themes, check an upgrade, or duplicate a theme (optionally upgrading the copy).
uc-storefront sf themes upgrade-checkShow what upgrading a theme would do, without changing anything.
uc-storefront sf themes duplicateCopy a theme into a new, inactive theme, and optionally upgrade only the copy.
uc-storefront sf themes job <job-id>Check a theme duplicate job once.

Tracking​

Explained in Analytics and tracking.

CommandWhat it does
uc-storefront sf trackingPrivacy rules, conversion settings and what is reported to analytics, ad and affiliate platforms.
uc-storefront sf tracking getRead the privacy rules and advanced conversion settings, every key listed (unset ones as null), with each section's hash.
uc-storefront sf tracking privacyThe storefront's per-region privacy rules.
uc-storefront sf tracking privacy setChange one or more privacy rules.
uc-storefront sf tracking advancedThe storefront's advanced conversion settings: URLs after checkout, the default currency and two switches.
uc-storefront sf tracking advanced setChange one or more advanced settings.
uc-storefront sf tracking utm-shortcodesShort codes that stand for a set of UTM and ITM values, for links in emails, ads and other sites.
uc-storefront sf tracking utm-shortcodes listList the shortcodes (the default when no subcommand is given), with the count and the limit.
uc-storefront sf tracking utm-shortcodes get <code>Read one shortcode, with its two link forms and the hash an update or delete sends back.
uc-storefront sf tracking utm-shortcodes create <code>Make a shortcode: 1 to 50 letters, digits, underscores and hyphens, with at least one UTM or ITM value.
uc-storefront sf tracking utm-shortcodes update <code>Change a shortcode's values, description or code.
uc-storefront sf tracking utm-shortcodes delete <code>Delete a shortcode.
uc-storefront sf tracking utm-shortcodes url <code>Print a shortcode's storefront link and, with --external, its link for another site.
uc-storefront sf tracking smart-attributionHow conversions are shared between ad and affiliate platforms, and, when active, what each is sent.
uc-storefront sf tracking smart-attribution getRead the configuration (the default): mode, model, split, lookback, platforms and those detected but not configured.
uc-storefront sf tracking smart-attribution enableTurn Smart Attribution on in report_only mode, which changes nothing any platform is sent.
uc-storefront sf tracking smart-attribution setChange the mode, model, split, lookback or platforms. Can require your approval.
uc-storefront sf tracking smart-attribution deleteDelete the configuration: every platform goes back to being sent conversions as before. Can require your approval.
uc-storefront sf tracking providersThe tracking providers the server knows, with their fields, events, consent gate and OAuth state.
uc-storefront sf tracking integrationRead, change or clear one tracking provider.
uc-storefront sf tracking integration get <provider>One provider: values (secrets as set and a mask only), events, consent gate, OAuth state, cost and the hash.
uc-storefront sf tracking integration set <provider>Change a provider's fields, secrets, events, consent gate or wholesale account numbers. Can require your approval.
uc-storefront sf tracking integration clear <provider>Clear every field, secret, event and the consent gate the API can change, and turn off Google Tag Gateway. Can require your approval.
uc-storefront sf tracking htmlThe custom tracking HTML (every page but the receipt) and conversion HTML (the receipt).
uc-storefront sf tracking html listBoth slots' sizes and hashes, without the HTML (the default).
uc-storefront sf tracking html pull <file>Write a slot's HTML to a new local file, with a .sf.json baseline beside it.
uc-storefront sf tracking html diff <file>Compare a local file with the slot now, and with its pull baseline.
uc-storefront sf tracking html renderRender the conversion HTML, or a local draft of it, as a test order's receipt would.
uc-storefront sf tracking html push <file>Write a local file to a slot, sending its baseline's hash. Can require your approval.
uc-storefront sf tracking affiliate-networksAffiliate networks: how a visit from each is detected and the conversion pixel it is sent.
uc-storefront sf tracking affiliate-networks listList the networks (the default), without their pixels.
uc-storefront sf tracking affiliate-networks get <oid>Read one network, with its pixel and the hash an update or delete sends back.
uc-storefront sf tracking affiliate-networks createAdd a network: network_name, parameter_name and parameter_value are required. Can require your approval.
uc-storefront sf tracking affiliate-networks update <oid>Change a network's fields or pixel. Can require your approval.
uc-storefront sf tracking affiliate-networks delete <oid>Delete a network. Can require your approval.
uc-storefront sf tracking checkPlan a browser check of a page's tracking (--path), then grade what the browser collected (--results).

Upsells​

Explained in Upsells.

CommandWhat it does
uc-storefront sf upsellsRead and manage upsell paths (who is offered what, where in checkout) and upsell offers.
uc-storefront sf upsells pathsUpsell paths: triggers, location, and the variations of offers.
uc-storefront sf upsells paths listList the storefront's upsell paths in order, first to last.
uc-storefront sf upsells paths get <oid>Read one upsell path.
uc-storefront sf upsells paths create <file>Create an upsell path from a JSON file, and save a baseline beside it.
uc-storefront sf upsells paths update <file>Replace an upsell path with the file pulled by 'get --out' (or created), checked against its baseline.
uc-storefront sf upsells paths disable <oid>Switch the upsell path off.
uc-storefront sf upsells paths archive <oid>File the path out of the default list.
uc-storefront sf upsells paths unarchive <oid>Bring the path back into the default list.
uc-storefront sf upsells paths move <oid>Move the path up, down, to the top or to the bottom of the order.
uc-storefront sf upsells paths duplicate <oid>Copy the whole path, switched off, right after it.
uc-storefront sf upsells paths enable <oid>Switch the upsell path on once the signed-in person approves. Can require your approval.
uc-storefront sf upsells offersUpsell offers: price, schedule, items and rules.
uc-storefront sf upsells offers listList the offers on the storefront's paths that are not archived, with their settings.
uc-storefront sf upsells offers get <oid>Read one upsell offer.
uc-storefront sf upsells offers create <file>Create an upsell offer from a JSON file, and save a baseline beside it.
uc-storefront sf upsells offers update <file>Replace an upsell offer with the file pulled by 'get --out' (or created), checked against its baseline.
uc-storefront sf upsells offers disable <oid>Switch the upsell offer off.
uc-storefront sf upsells offers duplicate <oid>Copy the offer, switched off, with its own copy of the container.
uc-storefront sf upsells offers enable <oid>Switch the upsell offer on once the signed-in person approves. Can require your approval.

Widget IDs​

Explained in Local editing workflow.

CommandWhat it does
uc-storefront sf idsReserve server widget IDs (requests above 100 are chunked).
Was this page helpful?