Skip to content

Command Line Tool Reference

Joshua Grosso edited this page Sep 29, 2019 · 3 revisions

Install

Install Cabal, a Haskell package manager, by following these instructions. Then, run cabal install axel to install the Axel library and executable. (If you use Stack, run stack exec -- cabal install axel instead.)

Stack

Axel uses Stack under-the-hood, so you should configure your project through the package.yaml file in the root of your project.

Haskell to Axel Project Migration

If you're migrating a project from Haskell to Axel file-by-file, you should still use the Axel command line tool to interact with your project.

Commands

Convert a Haskell Project [Experimental]

NOTE: The Haskell to Axel converter is currently in progress (#63).

To convert a Haskell project to Axel, enter the root directory of the project and run axel project convert.

Convert a Haskell File [Experimental]

NOTE: The Haskell to Axel converter is currently in progress (#63).

To convert a single Haskell file to Axel, run axel file convert <file path>.

Build and Run an Axel Project

To build and run an Axel project, enter the root directory of the project and run axel project run.

Build and Run an Axel File

To build and run a single Axel file, run axel file run <file path>.

Format an Axel Project

To auto-format an Axel project, enter the root directory of the project and run axel project format.

Format an Axel File

To auto-format a single Axel file, run axel file format <file path>.