@shopify/create-app/oclif.manifest.json

A CLI tool to create a new Shopify app.

{
  "commands": {
    "init": {
      "aliases": [],
      "args": {},
      "examples": [
        "<%= config.bin %> <%= command.id %> --name my-app --organization-id 123 --template reactRouter --flavor typescript",
        "<%= config.bin %> <%= command.id %> --client-id 123 --template none"
      ],
      "flags": {
        "auth-alias": {
          "description": "Alias of the Shopify account to use for authentication.",
          "env": "SHOPIFY_FLAG_AUTH_ALIAS",
          "name": "auth-alias",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "no-color": {
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "allowNo": false,
          "type": "boolean"
        },
        "verbose": {
          "description": "Increase the verbosity of the output. May include sensitive data.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "allowNo": false,
          "type": "boolean"
        },
        "name": {
          "char": "n",
          "description": "The name for the new app. When provided, skips the app selection prompt and creates a new app with this name. Required in non-interactive environments unless --client-id is provided.",
          "env": "SHOPIFY_FLAG_NAME",
          "hidden": false,
          "name": "name",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "path": {
          "char": "p",
          "env": "SHOPIFY_FLAG_PATH",
          "hidden": false,
          "name": "path",
          "default": "/home/runner/work/cli/cli/packages/create-app",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "template": {
          "description": "The app template. Accepts one of the following:\n       - <reactRouter|none>\n       - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify/<repository>/[subpath]#[branch]. Required if non interactive.",
          "env": "SHOPIFY_FLAG_TEMPLATE",
          "name": "template",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "flavor": {
          "description": "Which flavor of the given template to use. Required in non-interactive environments when the selected template offers multiple flavors.",
          "env": "SHOPIFY_FLAG_TEMPLATE_FLAVOR",
          "name": "flavor",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "package-manager": {
          "char": "d",
          "env": "SHOPIFY_FLAG_PACKAGE_MANAGER",
          "hidden": false,
          "name": "package-manager",
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "npm",
            "yarn",
            "pnpm",
            "bun"
          ],
          "type": "option"
        },
        "local": {
          "char": "l",
          "env": "SHOPIFY_FLAG_LOCAL",
          "hidden": true,
          "name": "local",
          "allowNo": false,
          "type": "boolean"
        },
        "client-id": {
          "description": "The Client ID of your app. Use this to automatically link your new project to an existing app. In non-interactive environments, provide this flag or both --name and --organization-id.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "client-id",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "organization-id": {
          "description": "The organization ID. Your organization ID can be found in your Dev Dashboard URL: https://dev.shopify.com/dashboard/<organization-id>. Required in non-interactive environments unless --client-id is provided.",
          "env": "SHOPIFY_FLAG_ORGANIZATION_ID",
          "exclusive": [
            "client-id"
          ],
          "hidden": false,
          "name": "organization-id",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "init",
      "pluginAlias": "@shopify/create-app",
      "pluginName": "@shopify/create-app",
      "pluginType": "core",
      "strict": true,
      "summary": "Create a new app project"
    }
  },
  "version": "4.7.0"
}