Saltar para o conteúdo
Verificado

Referência da CLI

Todos os comandos do xuda-cli, todos os campos de xuda.config.js e o que a sincronização com a cloud consegue fazer hoje.

O xuda-cli são três comandos, mais a ajuda. Nenhum aceita uma flag: qualquer argumento extra é um erro grave, e todas as definições vivem em xuda.config.js.

Comandos

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

O dev executa a aplicação sem qualquer ligação à cloud: responde por si próprio a um punhado de endpoints locais para que a aplicação tenha tudo o que precisa e, nesse modo isolado, trata também localmente as quatro operações de leitura e escrita de tabelas. Tudo o resto é encaminhado a montante quando há uma chave de API configurada, e recusado com uma mensagem clara quando não há.

xuda.config.js

Renderização no servidor

Defina ssr como first_page para renderizar no servidor o programa de entrada e passar daí o controlo ao cliente, ou full para renderizar a aplicação no servidor e hidratá-la no cliente. Deixe-o em none para renderizar tudo no navegador.

Defina o modo

Edite ssr em xuda.config.js.

Reinicie o dev

O npm run dev precisa de ser reiniciado após uma alteração de SSR.

Confirme a carga

A CLI renderiza o programa de entrada para uma string num contexto isolado, injeta a marcação na estrutura base e entrega ao cliente uma carga de renderização a partir da qual continuar.

Chaves de API

Abra Programadores, depois o separador Chaves de API no dashboard, e prima Criar chave. Dê um nome à chave, restrinja opcionalmente os Domínios permitidos e escolha um modo de acesso.

Uma chave com o acesso certo pode hoje chamar diretamente por HTTP os métodos de dados da aplicação: dbs_read, dbs_create, dbs_update e dbs_delete. Veja Framework JavaScript para o formato do pedido.

Sincronização com a cloud

A intenção do sync é trazer os documentos de um projeto na cloud para ficheiros-fonte locais e enviar de volta as alterações locais. Executa uma verificação prévia que confirma que quatro métodos da plataforma podem ser chamados antes de fazer mais alguma coisa:

get_app_system_api_methods, get_app_api_keys, get_project_docs, update_app_info_doc_to_db_couch.

Dois destes são métodos de sessão do dashboard que, por conceção, nunca aparecem na listagem do catálogo que a verificação lê, e os outros dois nem sequer estão registados como métodos da plataforma que se possam chamar, por isso a verificação não passa com o catálogo de métodos atual. Em separado, tudo o que precisa de api_key na CLI, incluindo o encaminhamento a montante e o próprio sync, carrega do disco módulos da plataforma que uma instalação npm publicada da CLI não inclui.

O que realmente chega hoje à cloud

Trate o dev como a cadeia de ferramentas local e use o Studio para levar o trabalho do projeto para o projeto na cloud. Nada disto afeta o desenvolvimento local: o dev, o recarregamento em direto, o SSR e os plugins funcionam todos sem qualquer ligação à cloud.

Quando o sync executa a sua sequência completa, ele: verifica que a aplicação expõe os métodos CPI necessários, verifica que a chave de API atual os pode usar, descarrega os documentos remotos para node_modules/.project_data/, cria os ficheiros-fonte locais em falta a partir desses documentos (os ficheiros locais existentes nunca são substituídos), recompila a fonte local de volta para node_modules/.project_data/ e envia para a cloud os documentos alterados.

Resolução de problemas

Planos e limites

A própria framework é gratuita: o desenvolvimento local em qualquer dos caminhos de escrita nunca chama um método condicionado por plano, os pacotes da CLI são publicados abertamente no npm e as chaves de API são gratuitas, seja qual for o modo de acesso. O que um plano de conta compra é a implementação, que não está disponível no plano Grátis e está disponível do Pro para cima.