Skip to main content

JavaScript (Flow)

The JavaScript/Flow indexer is built into the Flow system. It's also included in the Glean demo Docker image to try out.

Run the indexer​

Ensure that you have built and installed Glean and the glean executable is on your PATH.

You can index your Flow repository with:

glean index flow DIR --db-root DB --db NAME/INSTANCE

where

  • DB is the directory you want to store your Glean DBs
  • DIR is the root directory containing the Flow project (with .flowconfig)
  • NAME/INSTANCE is the name of the repository to create

Run the indexer (manually)​

flow glean DIR --output-dir JSON [--write-root PREFIX]

where

  • DIR is the root directory containing the JavaScript/Flow files
  • JSON is the directory in which to write the output .json files
  • PREFIX is a prefix to add to the file paths in the Glean index (this can be omitted if you don't need a prefix)

The generated files can be ingested into a Glean database using glean create.

Derived predicates​

Several predicates should be derived after indexing. For each stored predicate in the schema you should glean derive the predicate.

In the shell​

Flow source can also be indexed directly from the Glean shell:

:index flow DIR

Schema​

The schema is in glean/schema/source/flow.angle