Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saleor/cli
Command-line interface allowing interaction with Saleor Cloud environments.
https://github.com/saleor/cli
cli saleor saleor-cli saleor-cloud
Last synced: 2 months ago
JSON representation
Command-line interface allowing interaction with Saleor Cloud environments.
- Host: GitHub
- URL: https://github.com/saleor/cli
- Owner: saleor
- License: other
- Created: 2022-02-06T00:23:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T00:06:34.000Z (8 months ago)
- Last Synced: 2024-07-23T08:42:21.644Z (2 months ago)
- Topics: cli, saleor, saleor-cli, saleor-cloud
- Language: TypeScript
- Homepage:
- Size: 3.55 MB
- Stars: 68
- Watchers: 16
- Forks: 22
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Saleor CLI
Command-Line Interface for Saleor
**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.
To install the latest version of Saleor CLI, run the following command:
```
npm i -g @saleor/cli
```
You can also use `npx` to execute the Saleor CLI commands on the spot without installing the package.
```
npx saleor env list
```
> If you're using `nvm`, make sure that the `NVM_BIN` path is added to `PATH`
## Getting Started with CLI
### A quick demo
If 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:
```
saleor storefront create --demo
```
### Register
If you don't have a (free developer) Saleor Cloud account yet, create one with the following command:
```
saleor register
```
### Login
The `saleor` binary requires the Cloud API token that can be obtained via OAuth by running the `login` command:
```
saleor login
```
This 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.
You can now start executing any of the available commands.
Note: in order to log out you can use `saleor logout`.
### Create a storefront
The 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:
```
saleor store create my-new-storefront
```
### Create an API sanbox
You can create new API endpoints by running:
```
saleor env create
```
## Saleor Apps management 🦄
Please 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.
## Webhooks management
Coming soon 🔌
## Usage
```
Usage: saleor [options]
Commands:
saleor info Hello from Saleor
saleor status Show the login status for the systems that CLI depends on
saleor login Log in to the Saleor Cloud
saleor logout Log out from the Saleor Cloud
saleor configure [token] Configure Saleor CLI
saleor register Create a Saleor Cloud account [aliases: signup]
saleor trigger [event] This triggers a Saleor event
saleor organization [command] [aliases: org]
saleor environment [command] [aliases: env]
saleor backup [command]
saleor job [command]
saleor project [command]
saleor storefront [command] [aliases: store]
saleor telemetry [command] [aliases: tele]
saleor webhook [command] [aliases: hook]
saleor app [command]
saleor vercel [command]
saleor github [command]
saleor checkout [command]
Options:
--json Output the data as JSON [boolean]
--short Output data as text [boolean] [default: false]
-u, --instance, --url [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]
for more information, find the documentation at https://saleor.io
```
## Development
### Install dependencies
This project uses [pnpm](https://pnpm.io) for managing dependencies
```
pnpm install
```
### Run Watch Mode
```
pnpm watch
```
### Run CLI
```
node build/cli.js ...
```
### Environment variables
`RUN_FUNCTIONAL_TESTS`
Set to `true` to enable functional tests
`DEBUG`
Use it for debugging. Set to `saleor-cli:*` to show debug output for the Saleor CLI only. Set to `*` to show all debug output.
## Releasing CLI
Commands should be executed locally.
### Pre-Release
- pull latest changes from `main`, e.g.
```
git pull origin main
```
- check for the type errors with `pnpm tsc`
- check if the bundling finishes `pnpm bundle`
- publishing step involves uploading source maps to Sentry, log in with `sentry-cli login` if you intend to upload source maps
### Release
- change to the selected `release-*` branch; all `release-*` branches are protected
```
git checkout release/X.Y
```
where `X` and `Y` is the selected version
- compare the commits between latest release on that branch and the current `main`
```
git log --no-merges --cherry-pick --right-only release/X.Y...main
```
- cherry pick commits for the next release following the [Trunk Based Development Approach](https://trunkbaseddevelopment.com); do not include the `merge` commits
```
git cherry-pick SHA1 SHA2 SHA3
```
where `SHA1`, `SHA2`, `SHA3` are SHAs selected to be included in the upcoming version
- mark the new version in the package.json
- commit the new release + add the tag
```
git commit -m 'Release X.Y.0'
git tag X.Y.Z
```
- push the updated release branch to the origin
```
git push origin release/X.Y
```
- push the new tag to the origin
```
git push origin --tags
```
- publish from the release branch; use the `next` tag for the `RC` version
```
pnpm publish
```
or
```
pnpm publish --tag next
```
> [!IMPORTANT]
> CLI is currently published in an identical form to three packages in npmjs.com:
> - https://www.npmjs.com/package/@saleor/cli
> - https://www.npmjs.com/package/saleor-cli
> - https://www.npmjs.com/package/saleor
>
> When releasing a new version, modify name in `package.json` to `saleor-cli` and `saleor` respectively and repeat `pnpm publish` step.
> Do not commit these `package.json` changes.