Installation¶

Stable release¶

To install ASTx, run this command in your terminal:

$ pip install astx

This is the preferred method to install ASTx, as it will always install the most recent stable release.

For ASCII visualization of the AST in the console (using mermaid-ascii), install with the console extra:

$ pip install 'astx[console]'

Or install all optional dependencies at once:

$ pip install 'astx[all]'

Without the console extra, the console representation falls back to YAML output.

If you don't have pip installed, this Python installation guide can guide you through the process.

The sources for ASTx can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/arxlang/astx

Or download the tarball:

$ curl -OJL https://github.com/arxlang/astx/tarball/main

Once you have a copy of the source, you can install it with:

$ poetry install