{"id":13514027,"url":"https://github.com/ScreenStaring/shopify-dev-tools","last_synced_at":"2025-03-31T02:33:16.928Z","repository":{"id":90940450,"uuid":"394095191","full_name":"ScreenStaring/shopify-dev-tools","owner":"ScreenStaring","description":"Command-line program to assist with the development and/or maintenance of Shopify apps and stores","archived":false,"fork":false,"pushed_at":"2024-12-07T16:11:21.000Z","size":53,"stargazers_count":22,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T19:13:23.603Z","etag":null,"topics":["golang","metafields","scripttags","shopify","shopify-admin","shopify-admin-graphql","shopify-apps","shopify-developers","shopify-development","shopify-partners","webhooks"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScreenStaring.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-09T00:05:48.000Z","updated_at":"2024-12-07T16:11:25.000Z","dependencies_parsed_at":"2023-12-18T00:48:32.205Z","dependency_job_id":"65f87d50-0e21-434b-abdf-48128bcb0d76","html_url":"https://github.com/ScreenStaring/shopify-dev-tools","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenStaring%2Fshopify-dev-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenStaring%2Fshopify-dev-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenStaring%2Fshopify-dev-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenStaring%2Fshopify-dev-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScreenStaring","download_url":"https://codeload.github.com/ScreenStaring/shopify-dev-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246407401,"owners_count":20772126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","metafields","scripttags","shopify","shopify-admin","shopify-admin-graphql","shopify-apps","shopify-developers","shopify-development","shopify-partners","webhooks"],"created_at":"2024-08-01T05:00:43.739Z","updated_at":"2025-03-31T02:33:16.919Z","avatar_url":"https://github.com/ScreenStaring.png","language":"Go","readme":"# Shopify Development Tools\n\nCommand-line program to assist with the development and/or maintenance of Shopify apps and stores.\n\n## Installation\n\nDownload the version for your platform on the [releases page](https://github.com/ScreenStaring/shopify_dev_tools/releases).\nWindows, macOS/OS X, and GNU/Linux are supported.\n\n## Usage\n\n    NAME:\n       sdt - Shopify Development Tools\n\n    USAGE:\n       sdt command [command options] [arguments...]\n\n    VERSION:\n       0.0.5\n\n    COMMANDS:\n       admin, a                     Open admin pages\n       charges, c, ch               Do things with charges\n       metafield, m, meta           Metafield utilities\n       orders, o                    Information about orders\n       products, p                  Do things with products\n       graphql, gql                 Run a GraphQL query against the Admin API\n       shop, s                      Information about the given shop\n       scripttags                   ScriptTag utilities\n       themes, theme, t             Theme utilities\n       webhook, webhooks, hooks, w  Webhook utilities\n       help, h                      Shows a list of commands or help for one command\n\n    GLOBAL OPTIONS:\n       --help, -h     show help (default: false)\n       --version, -v  print the version (default: false)\n\n### Credentials\n\nYou'll need access to the Shopify store you want to execute commands against. Also see [Environment Variables](#environment-variables).\n\n#### Access Token\n\nIf the store has your app installed you can use the credentials generated when the shop installed your app:\n```\nsdt COMMAND --shop shopname --access-token value\n```\n\nIn this scenario you will likely need to execute the command against many shops, and having to lookup the token every\ntime you need it can become annoying. To simplify this process you can [specify an Access Token Command](#access-token-command).\n\n#### Key \u0026 Password\n\nIf you have access to the store via the Shopify Admin you can authenticate by\n[generating private app API credentials](https://shopify.dev/tutorials/generate-api-credentials). Once obtained they can be specified as follows:\n```\nsdt COMMAND --shop shopname --api-key thekey --api-password thepassword\n```\n\n#### Access Token Command\n\nInstead of specifying an access token per store you can provide a custom command that can lookup the token for the given `shop`.\nFor example:\n\n```\nsdt COMMAND --shop shopname --access-token '\u003cshopify-access-token.sh'\n```\n\nNote that `--access-token`'s argument begins with a `\u003c`. This tells Shopify Development Tools to treat the remaining argument\nas a command, execute it, and use the first line of its output as the shop's access token.\n\nThe access token command will be passed the shop's name, as given on the command-line.\n\nFor example, if your app used Rails `shopify-access-token.sh` may contain the following:\n```sh\n#!/bin/bash\n\nshop=$1\nssh example.com 'cd /app \u0026\u0026 RAILS_ENV=production bundle exec rails r \"print Shop.find_by!(:shopify_domain =\u003e ARGV[0]).token\" \"$shop\"'\n```\n\nFurthermore, you can use the [`SHOPIFY_ACCESS_TOKEN` environment variable](#environment-variables) to reduce the required options to\njust `shop`:\n\n```\nexport SHOPIFY_ACCESS_TOKEN='\u003cshopify-access-token.sh'\n# ...\nsdt COMMAND --shop shopname\n```\n\n#### Environment Variables\n\nYou can use the following environment variables to set credentials:\n\n- `SHOPIFY_SHOP`\n- `SHOPIFY_ACCESS_TOKEN` or `SHOPIFY_API_TOKEN`\n- `SHOPIFY_API_PASSWORD`\n- `SHOPIFY_API_KEY`\n\nOther environment variables:\n\n- `SHOPIFY_PRODUCT_FIELDS` - default fields for the `products` command's `--fields` flag\n\n### Commands\n\n#### Metafields\n\nMetafield utilities\n\n    NAME:\n       sdt metafield - Metafield utilities\n\n    USAGE:\n       sdt metafield command [command options] [arguments...]\n\n    COMMANDS:\n       customer, c                 List metafields for the given customer\n       product, products, prod, p  List metafields for the given product\n       shop, s                     List metafields for the given shop\n       storefront, sf              Storefront API utilities\n       variant, var, v             List metafields for the given variant\n       help, h                     Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### Charges\n\nDo things with charges\n\n    NAME:\n       sdt charges - Do things with charges\n\n    USAGE:\n       sdt charges command [command options] [arguments...]\n\n    COMMANDS:\n       ls, l      List the shop's charges or the charges given by the specified IDs\n       create, c  Create a one-time charge (application charge)\n       help, h    Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### Orders\n\nInformation about orders\n\n    NAME:\n       sdt orders - Information about orders\n\n    USAGE:\n       sdt orders command [command options] [arguments...]\n\n    COMMANDS:\n       useragent, ua  Info about the web browser used to place the order\n       ls             List the shop's orders or the orders given by the specified IDs\n       help, h        Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### Products\n\nDo things with products\n\n    NAME:\n       sdt products - Do things with products\n\n    USAGE:\n       sdt products command [command options] [arguments...]\n\n    COMMANDS:\n       ls, l    List some of a shop's products or the products given by the specified IDs\n       help, h  Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### GraphQL\n\nRun a GraphQL query against the Admin API\n\n    NAME:\n       sdt graphql - Run a GraphQL query against the Admin API\n\n    USAGE:\n       sdt graphql [command options] [query-file.graphql]\n\n    DESCRIPTION:\n       If query-file.graphql is not given query is read from stdin\n\n    OPTIONS:\n       --verbose                      Output Shopify API request/response (default: false)\n       --shop value                   Shopify domain or shop name to perform command against [$SHOPIFY_SHOP]\n       --api-password value           Shopify API password [$SHOPIFY_API_PASSWORD]\n       --access-token value           Shopify access token for shop [$SHOPIFY_ACCESS_TOKEN, $SHOPIFY_API_TOKEN]\n       --api-key value                Shopify API key to for shop [$SHOPIFY_API_KEY]\n       --api-version value, -a value  API version to use; default is a versionless call\n       --help, -h                     show help (default: false)\n\n#### ScriptTags\n\nScriptTag utilities\n\n    NAME:\n       sdt scripttags - ScriptTag utilities\n\n    USAGE:\n       sdt scripttags command [command options] [arguments...]\n\n    COMMANDS:\n       delete, del, rm, d  Delete the given ScriptTag\n       list, ls            List scripttags for the given shop\n       help, h             Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### Shop\n\nInformation about the given shop\n\n    NAME:\n       sdt shop - Information about the given shop\n\n    USAGE:\n       sdt shop command [command options] [arguments...]\n\n    COMMANDS:\n       access, a  List access scopes granted to the shop's token\n       info, i    Information about the shop\n       help, h    Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n#### Shopify Admin\n\nOpen admin pages\n\n    NAME:\n       sdt admin - Open admin pages\n\n    USAGE:\n       sdt admin command [command options] [arguments...]\n\n    COMMANDS:\n       order, orders, o            Open the given order ID for editing; if no ID given open the orders page\n       product, products, prod, p  Open the given product ID for editing; if no ID given open the products page\n       theme, t                    Open the currently published theme or given theme ID for editing\n       themes                      Open themes section of the admin (not for editing)\n       help, h                     Shows a list of commands or help for one command\n\n    OPTIONS:\n       --help, -h  show help (default: false)\n\n\n#### Themes\n\n    NAME:\n       sdt themes cp - Copy files to a theme\n\n    USAGE:\n       sdt themes cp [command options] themeid source [...] destination\n\n    OPTIONS:\n       --verbose             Output Shopify API request/response (default: false)\n       --shop value          Shopify domain or shop name to perform command against [$SHOPIFY_SHOP]\n       --api-password value  Shopify API password [$SHOPIFY_API_PASSWORD]\n       --access-token value  Shopify access token for shop [$SHOPIFY_ACCESS_TOKEN, $SHOPIFY_API_TOKEN]\n       --api-key value       Shopify API key to for shop [$SHOPIFY_API_KEY]\n       --help, -h            show help (default: false)\n\nCurrently `source` can only be a local file\n\n#### Webhooks\n\nWebhooks utilities\n\n    NAME:\n       sdt webhook - Webhook utilities\n\n    USAGE:\n       sdt webhook command [command options] [arguments...]\n\n    COMMANDS:\n       create, c\n       delete, del, rm, d\n       ls\n       help, h             Shows a list of commands or help for one command\n\n    OPTIONS:\n       --shop value          Shopify domain or shop name to perform command against [$SHOPIFY_SHOP]\n       --api-password value  Shopify API password [$SHOPIFY_API_PASSWORD]\n       --access-token value  Shopify access token for shop [$SHOPIFY_ACCESS_TOKEN, $SHOPIFY_API_TOKEN]\n       --api-key value       Shopify API key to for shop [$SHOPIFY_API_KEY]\n       --help, -h            show help (default: false)\n\n## See Also\n\n- [Shopify ID Export](https://github.com/ScreenStaring/shopify_id_export/) - Dump Shopify product and variant IDs —along with other identifiers— to a CSV or JSON file.\n\n## License\n\nReleased under the MIT License: http://www.opensource.org/licenses/MIT\n\n---\n\nMade by [ScreenStaring](http://screenstaring.com)\n","funding_links":[],"categories":["Go","Tools","工具","\u003ca name=\"webdev\"\u003e\u003c/a\u003eWeb development"],"sub_categories":["Command Line Tools","命令行工具"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScreenStaring%2Fshopify-dev-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FScreenStaring%2Fshopify-dev-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScreenStaring%2Fshopify-dev-tools/lists"}