On this page:
5.2.1 reach compile
5.2.2 reach init
5.2.3 reach hashes
5.2.4 reach run
5.2.5 reach scaffold
5.2.6 reach upgrade
5.2.7 reach update
5.2.8 reach version

5.2 Usage

Reach has a few sub-commands, each with their own options.

However, all commands support the following options:

5.2.1 reach compile

You compile your Reach code by executing

  $ reach compile SOURCE EXPORT ...

where SOURCE is your source file, and each EXPORT is an exported Reach.App.

If no SOURCE is provided, then index.rsh is used.

If no EXPORT is provided, then main is used.

reach compile supports the following options:

5.2.2 reach init

You can create template index.rsh and index.mjs files for a simple Reach app by running

  $ reach init

5.2.3 reach hashes

You can see which exact versions of Reach Docker images you are using by running

  $ reach hashes

This is more precise, but less readable, than reach version, in that each hash refers to the git commit used to build the image.

5.2.4 reach run

You can run a simple Reach application by executing

  $ reach run APP

If no APP is provided, index is used.

If APP is a directory, then APP/index is used.

This assumes

It then

reach run supports the following options:

reach run can be configured via the presence of certain files. In the absence of these files, reach run assumes a default behavior based on reach scaffold.

Furthermore, if all of the scaffolded files are present, then pay special attention to the Makefile that you write, because reach will use it in specific ways. Refer to the Makefile generated by reach scaffold for hints on how to get it right.

5.2.5 reach scaffold

You can create template package.json, Dockerfile, docker-compose.yml, and Makefile files for a simple Reach app by running

  $ reach scaffold

The files created are the same as those used temporarily by reach run.

5.2.6 reach upgrade

You can upgrade your Reach installation by executing

  $ reach upgrade

This may change the default version used by reach commands.

5.2.7 reach update

You can update the Docker images used by your Reach installation by executing

  $ reach update

This may change the patch version used by reach commands.

5.2.8 reach version

You can see what version of Reach you have installed by running

  $ reach version