Overview

The Riseact CLI is a tool that lets you create, develop, and deploy applications that integrate directly with the Riseact platform.

Features

• create a new application from a predefined template
• develop locally behind a public HTTPS URL, with no external services
• manage themes: scaffolding, preview, publishing

Requirements

• Have Git installed
• Have Node.js installed
• Use the latest version of Chrome or Firefox

No account with an external tunnelling service is needed: the CLI opens a tunnel to the Riseact infrastructure itself. If you want to know how it works, see Development tunnel.

Getting started

To get started you need to install the Riseact CLI. Download the version for your operating system from this page.

Once downloaded, extract the contents and move into the folder using the terminal.

To use the CLI you need to have set up a Partner account; if you haven't done so yet, follow this guide.

Once the account is set up, run the command

$ riseact auth login

and enter the credentials for your Partner account.

Make sure you have registered an application on Riseact. Start by creating a private application on a development organization, so you can test the application without publishing it.

Once done, you can initialize a new project with the command

$ riseact app init

following the on-screen instructions. This command will create a new folder with the name of the application, and inside it you will find the files needed to start developing.

To develop the application, move into the folder and start the development server with the command

$ riseact app dev

This command starts the local server, opens a tunnel to Riseact, and prints the public URL your application is reachable at:

App url: https://d3f2c1a9b8e7d6c5b4a3f2e1d0.tun.riseact.org

The URL is stable: for the same application it is identical on every run. The CLI updates the URL registered on Riseact for you, so there is nothing to copy by hand.

On the first run of a new application the CLI waits a few seconds to prepare the HTTPS certificate, and says so on screen. This happens once per application.

At this point, log in to your development organization on Riseact and go to the private applications list, from where you can activate the application and test it.

Commands

Command	What it does
riseact auth login	Authenticates the CLI with your Partner account
riseact auth logout	Removes the stored credentials
riseact app init	Creates a new project from a template
riseact app dev	Starts the development server and the tunnel
riseact theme init	Creates a new theme from an example theme
riseact theme dev	Syncs the folder with a theme on an organization, both ways
riseact theme pull	Downloads the files of a published version of one of your themes
riseact theme release	Publishes the theme as a new installable version
riseact theme package	Creates a zip of the theme to upload to Riseact
riseact config	Prints the CLI configuration

Add --help to any command to see its options. The global -w, --working-dir flag lets you run a command against another folder.

Changelog editor

riseact theme release opens an editor to write the changelog, the way git commit does. The editor is chosen in this order:

1. $VISUAL
2. $EDITOR
3. the editor key in the configuration file
4. git config core.editor
5. the first of nano, vi and vim that is installed

To set it once and for all, add to your ~/.config/riseact.yml:

editor: code --wait

The value can contain arguments. Graphical editors need the option that makes them wait for the file to be closed (code --wait, subl -w), otherwise the command resumes straight away and finds an empty changelog.

riseact config shows which editor would be used.

Stopping the server

Ctrl+C closes the development server and the tunnel together. The public URL immediately goes back to showing a page telling you to run riseact app dev, so you can restart right away without waiting.