aqua/USAGE.md
InversionSpaces feccffcb00
chore(docs): Update README (#892)
* Update README.md, add USAGE.md, delete INSTALL.md

* Add spaces

* fullBundleJS

---------

Co-authored-by: Dima <dmitry.shakhtarin@fluence.ai>
2023-09-19 11:33:39 +03:00

926 B

Usage of Aqua

Fluence CLI

The easiest way to use Aqua is through Fluence CLI with aqua command.

JS API

You can use Aqua compiler API directly from JS code by installing @fluencelabs/aqua-api package. See an example usage in api/api-example.

Build from sources

If you want to build Aqua compiler API from the source code, you need Scala's sbt installed.

Build to JS package

Javascript build is the default for Aqua compiler API.

Run sbt "aqua-apiJS/fullBundleJS". It will generate JS package in api/api-npm directory.

Build to JVM library

Building Aqua compiler API as JVM lib is technically possible, but is not supported.