Aller au contenu
Vérifié

Référence du CLI

Chaque commande de xuda-cli, chaque champ de xuda.config.js, et ce que la synchronisation cloud peut faire aujourd'hui.

xuda-cli se résume à trois commandes, plus l'aide. Aucune n'accepte de drapeau : tout argument supplémentaire est une erreur bloquante, et chaque réglage se trouve dans xuda.config.js.

Commandes

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

dev exécute l'app sans aucune connexion au cloud : il répond lui-même à une poignée de points d'accès locaux pour que l'app ait tout ce dont elle a besoin, et dans ce mode isolé il gère aussi localement les quatre opérations de lecture et d'écriture de tables. Tout le reste est transmis en amont quand une clé API est configurée, et refusé avec un message clair quand ce n'est pas le cas.

xuda.config.js

Rendu côté serveur

Définissez ssr sur first_page pour rendre côté serveur le programme d'entrée et passer la main au client ensuite, ou sur full pour rendre l'app côté serveur et l'hydrater côté client. Laissez none pour tout rendre dans le navigateur.

Définissez le mode

Modifiez ssr dans xuda.config.js.

Redémarrez dev

npm run dev doit être redémarré après un changement de SSR.

Vérifiez la charge utile

Le CLI rend le programme d'entrée en chaîne dans un contexte isolé, injecte le balisage dans la coque et donne au client une charge utile de rendu à partir de laquelle continuer.

Clés API

Ouvrez Développeurs, puis l'onglet Clés API dans le tableau de bord, et appuyez sur Créer une clé. Nommez la clé, restreignez éventuellement les Domaines autorisés, et choisissez un mode d'accès.

Une clé avec le bon accès peut appeler directement aujourd'hui les méthodes de données de l'app via HTTP : dbs_read, dbs_create, dbs_update et dbs_delete. Voir Framework JavaScript pour la forme de la requête.

Synchronisation cloud

L'intention de sync est de rapatrier les documents d'un projet cloud dans des fichiers source locaux et de renvoyer les changements locaux. Il exécute une vérification préalable qui confirme que quatre méthodes de la plateforme sont appelables avant de faire quoi que ce soit d'autre :

get_app_system_api_methods, get_app_api_keys, get_project_docs, update_app_info_doc_to_db_couch.

Deux d'entre elles sont des méthodes de session du tableau de bord qui, par conception, n'apparaissent jamais dans la liste du catalogue que lit la vérification, et les deux autres ne sont pas du tout enregistrées comme méthodes appelables de la plateforme, donc la vérification ne passe pas avec le catalogue de méthodes actuel. Par ailleurs, tout ce qui nécessite api_key dans le CLI, y compris la transmission en amont et sync lui-même, charge depuis le disque des modules de la plateforme qu'une installation npm publiée du CLI ne fournit pas.

Ce qui atteint réellement le cloud aujourd'hui

Considérez dev comme la chaîne d'outils locale et utilisez Studio pour faire arriver le travail du projet dans le projet cloud. Rien de cela n'affecte le développement local : dev, le rechargement en direct, le SSR et les plugins fonctionnent tous sans aucune connexion au cloud.

Quand sync exécute sa séquence complète, il : vérifie que l'app expose les méthodes CPI requises, vérifie que la clé API actuelle peut les utiliser, télécharge les documents distants dans node_modules/.project_data/, crée les fichiers source locaux manquants à partir de ces documents (les fichiers locaux existants ne sont jamais écrasés), recompile la source locale dans node_modules/.project_data/ et envoie les documents modifiés vers le cloud.

Dépannage

Forfaits et limites

Le framework lui-même est gratuit : le développement local avec l'une ou l'autre voie d'écriture n'appelle jamais de méthode soumise à un forfait, les paquets du CLI sont publiés ouvertement sur npm, et les clés API sont gratuites quel que soit le mode d'accès. Ce qu'achète un forfait de compte, c'est le déploiement, qui n'est pas disponible avec le forfait Free et l'est à partir de Pro.