frappecli

Narzędzie CLI do obsługi instancji Frappe Framework i ERPNext przez REST API. Pozwala na listowanie typów dokumentów, tworzenie, edytowanie i usuwanie rekordów, zarządzanie plikami oraz wywoływanie metod RPC na Twojej stronie Frappe. Idealne dla administratorów i programistów pracujących z systemami ERP, którzy potrzebują szybkiego dostępu do danych bez interfejsu graficznego.

1. Zainstaluj frappecli za pomocą Homebrew (brew tap pasogott/tap && brew install frappecli) lub ze źródła, klonując repozytorium i uruchamiając uv sync oraz uv pip install -e . w katalogu projektu.

2. Utwórz plik konfiguracyjny ~/.config/frappecli/config.yaml, w którym zdefiniujesz połączenia do swoich instancji Frappe — każde połączenie powinno zawierać URL, klucz API i sekret API. Wskaż również domyślną stronę (default_site).

3. Aby wyświetlić dostępne typy dokumentów, uruchom frappecli site doctypes. Możesz filtrować wyniki po module, np. frappecli site doctypes --module "Core", lub uzyskać szczegóły konkretnego typu za pomocą frappecli site info "User".

4. Do operacji na dokumentach użyj poleceń: frappecli doc list Customer do wylistowania rekordów (z opcjonalnym filtrowaniem i limitem), frappecli doc get Customer CUST-001 do pobrania pojedynczego dokumentu, frappecli doc create Customer --data '{...}' do utworzenia nowego rekordu oraz frappecli doc update Customer CUST-001 --data '{...}' do edycji istniejącego.

5. Do zarządzania plikami użyj frappecli file upload invoice.pdf --doctype "Sales Invoice" --docname "INV-001" do przesłania pliku (domyślnie prywatny), frappecli file upload logo.png --public do publicznego pliku, oraz frappecli file download /private/files/invoice.pdf -o ./downloads/ do pobrania pliku na dysk.

6. Wszystkie polecenia obsługują filtrowanie, sortowanie i wybór pól — sprawdź dokumentację dla każdego polecenia, aby dostosować wynik do swoich potrzeb.