Przejdź do treści
Zweryfikowano

Dokumentacja CLI

Każde polecenie xuda-cli, każde pole xuda.config.js i to, co synchronizacja z chmurą potrafi dziś.

xuda-cli to trzy polecenia plus pomoc. Żadne z nich nie przyjmuje flag: każdy dodatkowy argument to twardy błąd, a wszystkie ustawienia żyją w xuda.config.js.

Polecenia

bash
xuda-cli dev
xuda-cli sync
xuda-cli clean-readmes
xuda-cli --help

dev uruchamia aplikację bez żadnego połączenia z chmurą: sam odpowiada na garść lokalnych punktów końcowych, żeby aplikacja miała wszystko, czego potrzebuje, a w tym izolowanym trybie obsługuje też lokalnie cztery operacje odczytu i zapisu tabel. Wszystko inne jest przekazywane dalej do chmury, gdy skonfigurowano klucz API, a gdy go nie ma, jest odrzucane z czytelnym komunikatem.

xuda.config.js

Renderowanie po stronie serwera

Ustaw ssr na first_page, aby renderować na serwerze program wejściowy i stamtąd przekazać sterowanie klientowi, albo na full, aby renderować aplikację na serwerze i nawodnić ją po stronie klienta. Zostaw none, aby renderować wszystko w przeglądarce.

Ustaw tryb

Edytuj ssr w xuda.config.js.

Uruchom dev ponownie

npm run dev wymaga restartu po zmianie SSR.

Sprawdź ładunek

CLI renderuje program wejściowy do ciągu w kontekście piaskownicy, wstrzykuje znaczniki do powłoki i przekazuje klientowi ładunek renderowania, od którego ma kontynuować.

Klucze API

Otwórz Deweloperzy, potem kartę Klucze API w panelu i naciśnij Utwórz klucz. Nazwij klucz, opcjonalnie ogranicz Dozwolone domeny i wybierz tryb dostępu.

Klucz z odpowiednim dostępem może dziś wywoływać metody danych aplikacji bezpośrednio przez HTTP: dbs_read, dbs_create, dbs_update i dbs_delete. Kształt żądania znajdziesz w Frameworku JavaScript.

Synchronizacja z chmurą

Zamiarem sync jest pobranie dokumentów projektu z chmury do lokalnych plików źródłowych i wysłanie zmian lokalnych z powrotem. Najpierw uruchamia sprawdzenie warunku wstępnego, które potwierdza, że cztery metody platformy można wywołać:

get_app_system_api_methods, get_app_api_keys, get_project_docs, update_app_info_doc_to_db_couch.

Dwie z nich to metody sesji panelu, które z założenia nigdy nie pojawiają się na liście katalogu czytanej przez to sprawdzenie, a pozostałe dwie w ogóle nie są zarejestrowane jako wywoływalne metody platformy, więc sprawdzenie nie przechodzi względem obecnego katalogu metod. Osobno wszystko, co w CLI wymaga api_key, w tym przekazywanie do chmury i sam sync, ładuje z dysku moduły platformy, których opublikowana instalacja CLI z npm nie dostarcza.

Co faktycznie dociera dziś do chmury

Traktuj dev jako lokalny zestaw narzędzi i użyj Studio, aby przenieść pracę nad projektem do projektu w chmurze. Nic z tego nie wpływa na lokalne programowanie: dev, przeładowanie na żywo, SSR i wtyczki działają bez żadnego połączenia z chmurą.

Gdy sync wykonuje pełną sekwencję, to: sprawdza, czy aplikacja udostępnia wymagane metody CPI, sprawdza, czy obecny klucz API może z nich korzystać, pobiera zdalne dokumenty do node_modules/.project_data/, tworzy brakujące lokalne pliki źródłowe z tych dokumentów (istniejące pliki lokalne nigdy nie są nadpisywane), kompiluje lokalne źródła ponownie do node_modules/.project_data/ i wysyła zmienione dokumenty z powrotem do chmury.

Rozwiązywanie problemów

Plany i limity

Sam framework jest darmowy: lokalne programowanie na dowolnej ścieżce tworzenia nigdy nie wywołuje metody ograniczonej planem, pakiety CLI są publikowane otwarcie w npm, a klucze API są darmowe niezależnie od trybu dostępu. Plan konta kupuje wdrażanie, które nie jest dostępne w planie darmowym, a jest dostępne od Pro wzwyż.