Getting Started

Installation

Install the Arity CLI from crates.io with Cargo:

cargo install arity

Clone the repository and build a release binary:

git clone https://github.com/jolars/arity
cd arity
cargo build --release

The binary is written to target/release/arity.

To use the formatter inside R, install the arity package:

install.packages("arity")

See the R package documentation for details and RStudio setup for use in the editor.

With the CLI installed, run these commands in a terminal.

Format a file in place:

arity format file.R

Check formatting without writing changes:

arity format --check file.R

Lint a file (or pipe from stdin):

arity lint file.R

Run the language server over stdio (for editor integration):

arity lsp

See the CLI Reference for the full set of commands and options.