Panoramica
La CLI di Riseact è uno strumento che ti permette di creare, sviluppare e distribuire applicazioni che si integrano direttamente con la piattaforma Riseact.
Funzionalità
- creare una nuova applicazione da un template predefinito
- sviluppare in locale con un URL pubblico HTTPS, senza servizi esterni
- creare, sviluppare e pubblicare temi
Requisiti
Non serve alcun account su servizi di tunneling esterni: la CLI apre da sé un tunnel verso l'infrastruttura Riseact. Se vuoi capire come funziona, vedi Tunnel di sviluppo.
Come iniziare
Per cominciare è necessario installare la CLI di Riseact. Scarica la versione del tuo sistema operativo da questa pagina.
Una volta scaricato il file, estrai il contenuto e spostati nella cartella tramite il terminale.
Per utilizzare la CLI è necessario aver configurato un account Partner. Se non lo hai ancora fatto, segui questa guida.
Una volta configurato l'account, esegui il comando
$ riseact auth login
e inserisci le credenziali del tuo account Partner.
Assicurati di aver registrato un'applicazione su Riseact. Crea inizialmente un'applicazione privata su un'organizzazione di sviluppo, in modo da poter testare l'applicazione senza pubblicarla.
Una volta fatto potrai inizializzare un nuovo progetto con il comando
$ riseact app init
seguendo le istruzioni a schermo. Questo comando creerà una nuova cartella con il nome dell'applicazione e all'interno troverai i file necessari per iniziare a sviluppare.
Per sviluppare l'applicazione, spostati all'interno della cartella e avvia il server di sviluppo con il comando
$ riseact app dev
Questo comando avvia il server locale, apre un tunnel verso Riseact e stampa l'URL pubblico su cui la tua applicazione è raggiungibile:
App url: https://d3f2c1a9b8e7d6c5b4a3f2e1d0.tun.riseact.org
L'URL è stabile: per la stessa applicazione resta identico a ogni avvio. La CLI aggiorna da sé l'URL registrato su Riseact, quindi non devi copiarlo a mano da nessuna parte.
Al primo avvio di una nuova applicazione la CLI attende qualche secondo per preparare il certificato HTTPS, segnalandolo a schermo. Succede una volta sola per applicazione.
A questo punto accedi alla tua organizzazione di sviluppo su Riseact e vai alla lista delle applicazioni private: da lì potrai attivare l'applicazione e testarla.
Comandi
| Comando | Cosa fa |
|---|---|
riseact auth login | Autentica la CLI con il tuo account Partner |
riseact auth logout | Rimuove le credenziali salvate |
riseact app init | Crea un nuovo progetto da un template |
riseact app dev | Avvia il server di sviluppo e il tunnel |
riseact theme init | Crea un nuovo tema partendo da un tema di esempio |
riseact theme dev | Sincronizza la cartella con un tema su un'organizzazione, nei due sensi |
riseact theme pull | Scarica i file di una versione pubblicata di un tuo tema |
riseact theme release | Pubblica il tema come nuova versione installabile |
riseact theme package | Crea uno zip del tema da caricare su Riseact |
riseact config | Mostra la configurazione della CLI |
Aggiungi --help a qualsiasi comando per vederne le opzioni. Il flag globale -w, --working-dir permette di eseguire un comando puntando a un'altra cartella.
Editor per il changelog
riseact theme release apre un editor per scrivere il changelog, come fa git commit.
L'editor viene scelto in questo ordine:
$VISUAL$EDITOR- la chiave
editornel file di configurazione git config core.editor- il primo fra
nano,vievimche risulta installato
Per impostarlo una volta sola, aggiungi al tuo ~/.config/riseact.yml:
editor: code --wait
Il valore può contenere argomenti. Per gli editor grafici serve l'opzione che li fa
attendere la chiusura del file (code --wait, subl -w), altrimenti il comando riprende
subito e trova il changelog vuoto.
riseact config mostra quale editor verrebbe usato.
Fermare il server
Ctrl+C chiude insieme il server di sviluppo e il tunnel. L'URL pubblico torna immediatamente a mostrare una pagina che invita a lanciare riseact app dev, quindi puoi riavviare subito senza attese.