Shoper CLI

Czym jest Shoper CLI?

Shoper CLI to narzędzie wiersza poleceń, które umożliwia programistom i integratorom wydajną pracę z motywami graficznymi w sklepach opartych na platformie Shoper. CLI przyspiesza procesy deweloperskie, pozwala na automatyzację typowych zadań i wspiera praktyki CI/CD.

Wymagania systemowe:

• Node.js: min. 21.19.5, zalecana najnowsza wersja LTS lub wyższa
• System operacyjny: Windows (zalecany PowerShell), macOS lub Linux
• Dostęp do sklepu Shoper z pełnymi uprawnieniami w obszarze Konfiguracja (wygląd) (odczyt, dodawanie, edycja, usuwanie).

Dlaczego warto korzystać z Shoper CLI?

Shoper CLI, służy przede wszystkim do przeniesienia edycji szablonu z przeglądarki na własny komputer, co pozwala pracować szybciej w profesjonalnych edytorach kodu (jak np. VS Code) zamiast w niewygodnych oknach panelu administratora. 

Dzięki temu zyskujesz bezpieczeństwo, ponieważ pracujesz na lokalnej kopii plików i możesz łatwo cofnąć zmiany (używając np. systemów kontroli wersji jak Git). Jest to także niezbędne narzędzie do tworzenia zaawansowanych modułów oraz automatyzacji pracy, pozwalające wysyłać zmiany na serwer jedną komendą.

Jak zainstalować środowisko Shoper CLI?

Otwórz terminal (Wiersz polecenia lub PowerShell) i wpisz jedną komendę:

npm i -g @shoper/cli

Jak skonfigurować środowisko Shoper CLI?

W panelu administracyjnym sklepu przejdź do zakładki: Ustawienia (A), Ogólne (B), Administratorzy sklepu (C) i przejdź do edycji grupy administratorów (D), w której znajduje się login używany do logowania do Shoper CLI.

W zakładce: Uprawnienia (A) upewnij się, że dla obszaru Konfiguracja (wygląd) (B) są przypisane pełne uprawnienia, czyli: odczyt, dodawanie, edycja, usuwanie.

Pozostając w trybie edycji grupy administratorów, w zakładce: Administratorzy (A) przejdź do edycji loginu (B), którym będziesz się logować do Shoper CLI.

Przejdź do zakładki: Shoper CLI (A), a następnie kliknij: WYGENERUJ TOKEN (B).

W nowym oknie wprowadź nazwę tokenu (A), wybierz jak długo token ma pozostać aktywny (B) oraz kliknij: WYGENERUJ TOKEN (C).

Skopiuj wygenerowany token przed zamknięciem okna.

• Jeśli zamkniesz okno, nie uzyskasz później dostępu do wygenerowanego tokena
• Nie udostępniaj nikomu wygenerowanego tokena
• W każdej chwili możesz wygenerować nowy token.

Wklej wygenerowany token

Najczęściej wykonywane operacje

Oto lista komend, których będziesz używać najczęściej. Warto ją sobie zapisać lub wydrukować:

• shoper theme list – Pokaż listę wszystkich szablonów w sklepie.
• shoper theme pull [ID] – Pobierz szablon z serwera na dysk (nadpisze Twoje lokalne pliki!).
• shoper theme push – Wyślij Twoje lokalne pliki na serwer (nadpisze szablon w sklepie!).
• shoper theme verify – Sprawdź, czy nie zrobiłeś błędu w strukturze plików przed wysłaniem.
• shoper update – Aktualizacja samego narzędzia CLI.

Pełna dokumentacja techniczna znajduje się na stronie Shoper Developers.