{"id":13469531,"url":"https://github.com/saleor/cli","last_synced_at":"2025-06-28T11:08:32.562Z","repository":{"id":37092946,"uuid":"456019031","full_name":"saleor/cli","owner":"saleor","description":"Command-line interface allowing interaction with Saleor Cloud environments.","archived":false,"fork":false,"pushed_at":"2025-03-31T12:49:08.000Z","size":3764,"stargazers_count":69,"open_issues_count":22,"forks_count":23,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-06-27T11:13:55.087Z","etag":null,"topics":["cli","saleor","saleor-cli","saleor-cloud"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saleor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-06T00:23:21.000Z","updated_at":"2025-05-21T23:05:47.000Z","dependencies_parsed_at":"2023-10-16T21:14:57.557Z","dependency_job_id":"322b70ad-230b-4c75-8775-696bc7168d17","html_url":"https://github.com/saleor/cli","commit_stats":{"total_commits":882,"total_committers":14,"mean_commits":63.0,"dds":0.4693877551020408,"last_synced_commit":"9a48c831265c4dee64bbbc6ae0dc070e037fc97d"},"previous_names":["saleor/cli","saleor/saleor-cli"],"tags_count":200,"template":false,"template_full_name":null,"purl":"pkg:github/saleor/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saleor%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saleor%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saleor%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saleor%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saleor","download_url":"https://codeload.github.com/saleor/cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saleor%2Fcli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262419810,"owners_count":23308101,"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":["cli","saleor","saleor-cli","saleor-cloud"],"created_at":"2024-07-31T15:01:43.810Z","updated_at":"2025-06-28T11:08:32.553Z","avatar_url":"https://github.com/saleor.png","language":"TypeScript","readme":"\n\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"150\" alt=\"saleor-cli\" src=\"https://user-images.githubusercontent.com/200613/221163557-797cf981-3c65-4a0b-afd3-304b6d7ac537.png\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eSaleor CLI\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003eCommand-Line Interface for Saleor\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://saleor.io/\"\u003eWebsite\u003c/a\u003e\n  \u003cspan\u003e | \u003c/span\u003e\n  \u003ca href=\"https://docs.saleor.io/docs/3.x/cli\"\u003eDocs\u003c/a\u003e\n\u003c/div\u003e\n\n\u003e [!TIP]\n\u003e Questions or issues? Check our [discord](https://discord.gg/H52JTZAtSH) channel for help.\n\n**Saleor CLI** is designed to boost your productivity and improve development experience with Saleor and Saleor Cloud. It will take the burden of spawning new storefronts and apps locally, managing and connecting them with Saleor instances, or establishing tunnels for local development in seconds.\n\nTo install the latest version of Saleor CLI, run the following command:\n\n```\nnpm i -g @saleor/cli\n```\n\nYou can also use `npx` to execute the Saleor CLI commands on the spot without installing the package.\n\n```\nnpx saleor env list\n```\n\n\u003e If you're using `nvm`, make sure that the `NVM_BIN` path is added to `PATH`\n\n## Getting Started with CLI\n\n### A quick demo\n\nIf you're new to Saleor you might want to start by bootstrapping an end-to-end local storefront development environment (and Saleor Cloud sandbox API instance). Since it requires Cloud access, you will be asked to register to a free Saleor Cloud developer account or log in. Then the command will automatically create your new local storefront environment and connect it to a newly created Saleor API instance/sandbox:\n\n```\nsaleor storefront create --demo\n```\n\n### Register\n\nIf you don't have a (free developer) Saleor Cloud account yet, create one with the following command:\n\n```\nsaleor register\n```\n\n### Login\n\nThe `saleor` binary requires the Cloud API token that can be obtained via OAuth by running the `login` command:\n\n```\nsaleor login\n```\n\nThis command will open a browser and ask for your Saleor Cloud credentials. Once logged in, it will store your Cloud API token locally for the CLI to use.\n\nYou can now start executing any of the available commands.\n\nNote: in order to log out you can use `saleor logout`.\n\n### Create a storefront\n\nThe following command will take you through the process of creating a new [react-storefront](https://github.com/saleor/react-storefront) and configuring it with a chosen Saleor Cloud API instance:\n\n```\nsaleor store create my-new-storefront\n```\n\n### Create an API sanbox\n\nYou can create new API endpoints by running:\n\n```\nsaleor env create\n```\n\n## Saleor Apps management 🦄\n\nPlease check out the [Saleor App Template](https://github.com/saleor/saleor-app-template) [docs](https://github.com/saleor/saleor-app-template#readme) for the latest documentation.\n\n## Webhooks management\n\nComing soon 🔌\n\n## Usage\n\n```\nUsage: saleor \u003ccommand\u003e [options]\n\nCommands:\n  saleor info                    Hello from Saleor\n  saleor status                  Show the login status for the systems that CLI depends on\n  saleor login                   Log in to the Saleor Cloud\n  saleor logout                  Log out from the Saleor Cloud\n  saleor configure [token]       Configure Saleor CLI\n  saleor register                Create a Saleor Cloud account  [aliases: signup]\n  saleor trigger [event]         This triggers a Saleor event\n  saleor organization [command]  [aliases: org]\n  saleor environment [command]  [aliases: env]\n  saleor backup [command]\n  saleor job [command]\n  saleor project [command]\n  saleor storefront [command]  [aliases: store]\n  saleor webhook [command]  [aliases: hook]\n  saleor app [command]\n  saleor vercel [command]\n  saleor github [command]\n  saleor checkout [command]\n\nOptions:\n      --json             Output the data as JSON  [boolean]\n      --short            Output data as text  [boolean] [default: false]\n  -u, --instance, --url  [string]\n  -V, --version          Show version number  [boolean]\n  -h, --help             Show help  [boolean]\n\nfor more information, find the documentation at https://saleor.io\n```\n\n## Development\n\n### Install dependencies\n\nThis project uses [pnpm](https://pnpm.io) for managing dependencies\n\n```\npnpm install\n```\n\n### Run Watch Mode\n\n```\npnpm watch\n```\n\n### Run CLI\n\n```\nnode build/cli.js ...\n```\n\n### Environment variables\n\n`RUN_FUNCTIONAL_TESTS`\n\nSet to `true` to enable functional tests\n\n\n`DEBUG`\n\nUse it for debugging. Set to `saleor-cli:*` to show debug output for the Saleor CLI only. Set to `*` to show all debug output.\n\n## Releasing CLI\n\nCommands should be executed locally.\n\n### Pre-Release\n\n- pull latest changes from `main`, e.g.\n\n```\ngit pull origin main\n```\n\n- check for the type errors with `pnpm tsc`\n- check if the bundling finishes `pnpm bundle`\n- publishing step involves uploading source maps to Sentry, log in with `sentry-cli login` if you intend to upload source maps\n\n### Release\n\n- change to the selected `release-*` branch; all `release-*` branches are protected\n\n```\ngit checkout release/X.Y\n```\n\nwhere `X` and `Y` is the selected version\n\n- compare the commits between latest release on that branch and the current `main`\n\n```\ngit log --no-merges --cherry-pick --right-only release/X.Y...main\n```\n\n- cherry pick commits for the next release following the [Trunk Based Development Approach](https://trunkbaseddevelopment.com); do not include the `merge` commits\n\n```\ngit cherry-pick SHA1 SHA2 SHA3\n```\n\nwhere `SHA1`, `SHA2`, `SHA3` are SHAs selected to be included in the upcoming version\n\n- mark the new version in the package.json\n- commit the new release + add the tag\n\n```\ngit commit -m 'Release X.Y.0'\ngit tag X.Y.Z\n```\n\n- push the updated release branch to the origin\n\n```\ngit push origin release/X.Y\n```\n\n- push the new tag to the origin\n\n```\ngit push origin --tags\n```\n\n- publish from the release branch; use the `next` tag for the `RC` version\n\n```\npnpm publish\n```\n\nor\n\n```\npnpm publish --tag next\n```\n\n\u003e [!IMPORTANT]\n\u003e CLI is currently published in an identical form to three packages in npmjs.com:\n\u003e - https://www.npmjs.com/package/@saleor/cli\n\u003e - https://www.npmjs.com/package/saleor-cli\n\u003e - https://www.npmjs.com/package/saleor\n\u003e\n\u003e When releasing a new version, modify name in `package.json` to `saleor-cli` and `saleor` respectively and repeat `pnpm publish` step.\n\u003e Do not commit these `package.json` changes.\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaleor%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaleor%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaleor%2Fcli/lists"}