Overview

The Riseact CLI creates, develops and publishes applications and themes for Riseact:

• creates a new application from a template;
• runs it locally behind a public HTTPS URL, through a development tunnel to Riseact;
• creates, develops and publishes themes.

Requirements

• Git
• Node.js
• the latest version of Chrome or Firefox
• a Partner account: if you do not have one, follow this guide

Getting started

Download the CLI for your operating system from this page, extract the archive and open a terminal in the folder.

Log in with your Partner account credentials:

$ riseact auth login

Then register an application on Riseact. To start, create a private application on a development organization, so you can try it without publishing it.

Initialize the project following the on-screen instructions:

$ riseact app init

The command creates a folder named after the application, with the files to get started. Move into the folder and start the development server:

$ riseact app dev

The CLI starts the local server, opens the tunnel and prints the application's public URL:

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

The URL stays the same on every run and the CLI updates it on Riseact for you. On the first run of a new application it waits a few seconds to prepare the HTTPS certificate.

Now log in to your development organization and open the private applications: from there you activate the application and try 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

--help shows the options of any command. The global -w, --working-dir flag runs the command against another folder.

riseact app dev options

Option	What it does
-c, --command	Command that starts the development server, instead of npm run dev
-p, --port	Pins the local proxy to a port; without it, a free one is picked on every run

See The local port for when to pin it.

Changelog editor

riseact theme release opens an editor for the changelog, like git commit. 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 installed of nano, vi and vim

To set it in ~/.config/riseact.yml:

editor: code --wait

The value can contain arguments. Graphical editors need the option that waits for the file to be closed (code --wait, subl -w), otherwise the changelog comes out empty.

riseact config shows the editor in use.

Stopping the server

Ctrl+C closes the development server and the tunnel. You can restart right away.