adastra-cli
Version:
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
351 lines • 10.9 kB
JSON
{
"version": "0.4.0",
"commands": {
"build": {
"id": "build",
"description": "Builds all static files into the theme assets folder.",
"strict": true,
"pluginName": "adastra-cli",
"pluginAlias": "adastra-cli",
"pluginType": "core",
"aliases": [],
"flags": {
"log-level": {
"name": "log-level",
"type": "option",
"description": "Adjust console output verbosity when building files.",
"required": false,
"multiple": false,
"options": [
"info",
"silent",
"error",
"warn"
],
"default": "info"
}
},
"args": {}
},
"check": {
"id": "check",
"description": "Validate the theme using theme check same as shopify theme check command.",
"strict": true,
"pluginName": "adastra-cli",
"pluginAlias": "adastra-cli",
"pluginType": "core",
"aliases": [],
"flags": {
"environment": {
"name": "environment",
"type": "option",
"description": "The environment to apply to the current command.",
"hidden": true,
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"description": "Increase the verbosity of the logs.",
"hidden": false,
"allowNo": false
},
"path": {
"name": "path",
"type": "option",
"description": "The path to your theme directory.",
"hidden": false,
"multiple": false,
"default": "."
},
"auto-correct": {
"name": "auto-correct",
"type": "boolean",
"char": "a",
"description": "Automatically fix offenses",
"required": false,
"allowNo": false
},
"category": {
"name": "category",
"type": "option",
"char": "c",
"description": "Only run this category of checks\nRuns checks matching all categories when specified more than once",
"required": false,
"multiple": false
},
"config": {
"name": "config",
"type": "option",
"char": "C",
"description": "Use the config provided, overriding .theme-check.yml if present\nUse :theme_app_extension to use default checks for theme app extensions",
"required": false,
"multiple": false
},
"exclude-category": {
"name": "exclude-category",
"type": "option",
"char": "x",
"description": "Exclude this category of checks\nExcludes checks matching any category when specified more than once",
"required": false,
"multiple": false
},
"fail-level": {
"name": "fail-level",
"type": "option",
"description": "Minimum severity for exit with error code",
"required": false,
"multiple": false,
"options": [
"error",
"suggestion",
"style"
]
},
"init": {
"name": "init",
"type": "boolean",
"description": "Generate a .theme-check.yml file",
"required": false,
"allowNo": false
},
"list": {
"name": "list",
"type": "boolean",
"description": "List enabled checks",
"required": false,
"allowNo": false
},
"output": {
"name": "output",
"type": "option",
"char": "o",
"description": "The output format to use",
"required": false,
"multiple": false,
"options": [
"text",
"json"
],
"default": "text"
},
"print": {
"name": "print",
"type": "boolean",
"description": "Output active config to STDOUT",
"required": false,
"allowNo": false
},
"version": {
"name": "version",
"type": "boolean",
"char": "v",
"description": "Print Theme Check version",
"required": false,
"allowNo": false
}
},
"args": {}
},
"dev": {
"id": "dev",
"description": "Lauches a Vite development server and uploads the current theme as a development theme to the connected store, While running, changes will push to the store in real time.",
"strict": true,
"pluginName": "adastra-cli",
"pluginAlias": "adastra-cli",
"pluginType": "core",
"aliases": [],
"flags": {
"environment": {
"name": "environment",
"type": "option",
"description": "The environment to apply to the current command.",
"hidden": true,
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"description": "Increase the verbosity of the logs.",
"hidden": false,
"allowNo": false
},
"path": {
"name": "path",
"type": "option",
"description": "The path to your theme directory.",
"hidden": false,
"multiple": false,
"default": "."
},
"host": {
"name": "host",
"type": "option",
"description": "Set which network interface the web server listens on. The default value is 127.0.0.1.",
"multiple": false
},
"live-reload": {
"name": "live-reload",
"type": "option",
"description": "The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload",
"multiple": false,
"options": [
"hot-reload",
"full-page",
"off"
],
"default": "full-page"
},
"poll": {
"name": "poll",
"type": "boolean",
"description": "Force polling to detect file changes.",
"allowNo": false
},
"theme-editor-sync": {
"name": "theme-editor-sync",
"type": "boolean",
"char": "e",
"description": "Synchronize Theme Editor updates in the local theme files.",
"allowNo": false
},
"port": {
"name": "port",
"type": "option",
"description": "Local port to serve theme preview from.",
"multiple": false
},
"store": {
"name": "store",
"type": "option",
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"multiple": false
},
"theme": {
"name": "theme",
"type": "option",
"char": "t",
"description": "Theme ID or name of the remote theme.",
"multiple": false
},
"only": {
"name": "only",
"type": "option",
"char": "o",
"description": "Hot reload only files that match the specified pattern.",
"multiple": true
},
"ignore": {
"name": "ignore",
"type": "option",
"char": "x",
"description": "Skip hot reloading any files that match the specified pattern.",
"multiple": true
},
"stable": {
"name": "stable",
"type": "boolean",
"description": "Performs the upload by relying in the legacy upload approach (slower, but it might be more stable in some scenarios)",
"hidden": true,
"allowNo": false
},
"force": {
"name": "force",
"type": "boolean",
"char": "f",
"description": "Proceed without confirmation, if current directory does not seem to be theme directory.",
"hidden": true,
"allowNo": false
},
"password": {
"name": "password",
"type": "option",
"description": "Password generated from the Theme Access app.",
"hidden": false,
"multiple": false
}
},
"args": {},
"ignoredFiles": [
"assets/adastra.manifest.json",
"package.json",
"package-lock.json",
"jsconfig.*",
"tsconfig.*",
"./*.config.*",
"src/",
"test/",
"node_modules"
]
},
"preview": {
"id": "preview",
"description": "Opens a preview of your remote development theme.",
"strict": true,
"pluginName": "adastra-cli",
"pluginAlias": "adastra-cli",
"pluginType": "core",
"aliases": [],
"flags": {
"environment": {
"name": "environment",
"type": "option",
"description": "The environment to apply to the current command.",
"hidden": true,
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"description": "Increase the verbosity of the logs.",
"hidden": false,
"allowNo": false
},
"password": {
"name": "password",
"type": "option",
"description": "Password generated from the Theme Access app.",
"hidden": false,
"multiple": false
},
"development": {
"name": "development",
"type": "boolean",
"char": "d",
"description": "Delete your development theme.",
"allowNo": false
},
"editor": {
"name": "editor",
"type": "boolean",
"char": "e",
"description": "Open the theme editor for the specified theme in the browser.",
"allowNo": false
},
"live": {
"name": "live",
"type": "boolean",
"char": "l",
"description": "Pull theme files from your remote live theme.",
"allowNo": false
},
"theme": {
"name": "theme",
"type": "option",
"char": "t",
"description": "Theme ID or name of the remote theme.",
"multiple": false
},
"store": {
"name": "store",
"type": "option",
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"multiple": false
}
},
"args": {}
}
}
}