Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

adastra-cli

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

adastra-cli

Adastra CLI ✨ is a CLI toolkit built on top of Shopify CLI 3.X, this means that existing Adastra commands are the same as Shopify's. The goal from this package is to allow developers to use one CLI intefrace between the Vite and Shopify development server


Version published
Weekly downloads
829
increased by170.92%
Maintainers
1
Weekly downloads
 
Created

adastra-cli

Adastra CLI ✨ is a CLI toolkit built on top of Shopify CLI 3.X, this means that existing Adastra commands are the same as Shopify's. The goal from this package is to allow developers to use one CLI intefrace between the Vite and Shopify development servers.

Requirements

Please make sure you have these two already set up in your local environment for Adastra CLI to work properly.

Install Shopify CLI and Adastra CLI

Shopify CLI is managed as a set of Node.js packages, To install Shopify CLI for themes, install the @shopify/cli and @shopify/theme Node.js packages globally using the command line and same for adastra-cli as well.

npm install -g @shopify/cli @shopify/theme adastra-cli

Using Yarn/PNPM

yarn global add @shopify/cli @shopify/theme adastra-cli
# pnpm add -g @shopify/cli @shopify/theme adastra-cli

Already have Shopify CLI installed?

You can install adastra-cli separately with the following command.

npm install -g adastra-cli

Using Yarn/PNPM

yarn global add adastra-cli
# pnpm add -g adastra-cli

Verify the installation

To verify that Shopify CLI is installed properly, run the following command (The command returns a version number)

shopify version

Verify Adastra CLI with (The command returns a help message)

adastra --help

Commands

To launch Shopify and Vite development server, you can use adastra dev command which support all shopify theme dev flags and arguments. Here is an example:

adastra dev -s example-store.myshopify.com
# same as shopify theme dev -s example-store.myshopify.com

💡 The command will launch two dev servers, the first for Vite at localhost:5173 to server static files from the src directory and the second for Shopify at localhost:9292 to serve your theme.

All commands must run from the root of the theme project.

Other commands

CommandAction
adastra buildBuild and minifies your production static files to ./assets/ folder
adastra previewPreview of your remote development theme, before deploying
adastra checkRun theme check to lint the theme
adastra --helpGet help using the Adastra CLI

Want to learn more?

Feel free to check our documentation or jump into our Discord server.

Keywords

FAQs

Package last updated on 03 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts