skills.rest
spree
spreeOFFICIAL
Explore all skills by this author →
Website𝕏@spreecommerceGitHub

spree-cli

Interact with the Spree Admin API via command-line CRUD operations.

4|Updated Jun 9, 2026
Search Tags:#API interaction#Command-line#Admin API#Spree Commerce#Data manipulation
One-click install
npx skills add https://github.com/spree/agent-skills --skill spree-cli
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: spree-cli
Source: https://github.com/spree/agent-skills/tree/main/skills/spree-cli
Command: npx skills add https://github.com/spree/agent-skills --skill spree-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the need for efficient and convenient command-line access to the Spree Admin API, allowing users to quickly explore, debug, and interact with their Spree store data without the need for a graphical interface.

Core Features & Use Cases

  • Command-Line API Access: Interact with the Spree Admin API using spree api commands for GET, POST, PATCH, and DELETE operations.
  • Interactive Debugging: Quickly inspect and manipulate data, diagnose issues, and test scenarios in real-time.
  • Offline Discovery: View available endpoints and their schemas without an internet connection.
  • Use Case: When troubleshooting a specific issue in the Spree Admin API, use the CLI to inspect the order state, check product details, or debug failed requests.

Quick Start

To get started, install the spree-cli skill and run the following command to retrieve all active products:

spree api get /products -q status_eq=active

Frequently Asked Questions about spree-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I interact with the Spree Admin API from the command line?▼

You can interact with the Spree Admin API by using spree api commands to perform GET, POST, PATCH, and DELETE operations on store data directly from your terminal.

Can I inspect and debug Spree Commerce store data without a GUI?▼

Yes, you can inspect and debug Spree Commerce store data without a GUI by running command-line operations to check product details, view order states, and diagnose API issues programmatically.

How do I retrieve active products using the Spree Admin API CLI?▼

To retrieve active products, run the command spree api get /products -q status_eq=active, which queries the Spree Admin API and filters for active product records.

Does the Spree CLI require an internet connection to view available API endpoints?▼

No, the Spree CLI supports offline discovery, allowing you to view available endpoints and their schemas without needing an active internet connection.

What do I need to know to use a command-line interface for Spree API data manipulation?▼

You need familiarity with Spree Commerce, RESTful APIs, and basic command-line usage to effectively perform CRUD operations and manipulate store data.

What is the best way to test scenarios and manipulate Spree store data in real-time?▼

The best way to test scenarios is by using the Spree CLI to interactively manipulate data, debug failed requests, and inspect store information in real-time without a graphical interface.

Related Skills

Explore More Software Engineering Skills→
urivauriva

shopify

Retrieve Shopify order status, shipment tracking, and product catalog data via the Admin REST API.

Community
Intermediate
R3n3gade-aiR3n3gade-ai

financial-document-parser

Parse financial documents into structured JSON, Markdown, or CSV outputs.

Community
Intermediate
Tai-ch0802Tai-ch0802
2

bash-linux

Reference Bash and Linux commands, operators, and scripting patterns.

Community
Intermediate
spreespree
4

spree-admin

Generate and modify Spree admin resources with Rails generators.

Official
Advanced