enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-12-19 07:02:04 +03:00
Code Issues Projects Releases Wiki Activity
d72de5f306
enso/docs/getting-enso.md
Radosław Waśko 3b1d260059
[Build,Doc] Make builds work outside a repository 
1. This commit ensures that builds outside of repository don't file not being
   able to fetch the git metadata for the version string but just report a
   warning.
2. It also clarifies documentation on getting Enso artifacts from CI.

PR #1036
2020-07-27 12:45:19 +02:00

3.0 KiB
Raw Blame History

layout title category tags order
developer-doc Getting Enso summary
contributing
installation
5

Getting Enso

Enso packages can currently be obtained from the per-commit CI builds. See the build workflow on GitHub Actions, which should show a list of recent CI builds. The workflow of interest is Engine CI. You can navigate to the most recent build, which will display a list of attached artifacts. The artifact of interest is enso-engine-<version> (currently enso-engine-0.1.0).

Dependencies

The Enso distribution requires to be run with the appropriate version of GraalVM. You can get the Community Edition pre-built distributions from the GitHub releases site. It is important to run Enso with exactly the version specified here. Given that Graal is still a relatively young project, even the minor version changes introduce breaking API changes. The current version of GraalVM required for Enso is 20.1.0, and it must be the Java 11 build.

Before running the Enso packages, make sure that the JAVA_HOME environment variable points to the correct home location of the Graal distribution.

Running Enso

The distribution contains two main executables of interest:

  1. The project manager. This executable is currently used for testing the IDE, though in the future it will rarely be run directly and rather will be launched automatically by the IDE. To run the project manager, run the bin/project-manager script (Linux and MacOS) or the bin/project-manager.bat script (Windows).
  2. The Enso CLI. This allows to create and run Enso projects from the command line. To launch the Enso CLI, run the bin/enso script (Linux and MacOS) or the bin/enso.bat script (Windows).

Again, it is necessary for you to set the JAVA_HOME variable correctly.

Troubleshooting

This section lists the most common failures and their probable causes.

  1. The exception java.lang.IllegalArgumentException: Could not find option with name enso-runtime-server.enable. It can contain a different option name. This exception signals problems with the Graal distribution. Make sure you're running Enso with the correct version of GraalVM. You can verify the version of JDK used by running bin/enso --version. Take note of the version displayed in the Running on section. It should be similar to:

    Running on: OpenJDK 64-Bit Server VM, GraalVM Community, JDK 11.0.7+10-jvmci-20.1-b02
            Linux 4.15.0-106-generic (amd64)

    It could also be caused by not using the launcher scripts and trying to run the component .jar files via java -jar without setting the necessary options. Use the launcher scripts.