Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.88 KB

README.md

File metadata and controls

75 lines (47 loc) · 1.88 KB
Raw

Agda CLI

Agda CLI is a command-line tool that provides a set of utilities for working with Agda files. It offers functionalities such as checking Agda files, running Agda programs, compiling Agda to executables, and compiling Agda to JavaScript.

Installation

To install the development version of Agda CLI globally, clone this repository, and run the following command in the cloned directory:

npm install -g .

Depending on your system configuration, you may need to run the command as root, or use sudo.

Usage

agda-cli

The main command-line interface for checking, running, and compiling Agda files.

agda-cli [check|run|runIO] <file.agda> [backend]
  • check: Checks the Agda file and displays any errors, holes, or warnings.
  • run: Runs the Agda program and displays the output.
  • runIO: Compiles and runs the Agda program with IO capabilities.

agda-compile

Compiles an Agda file to an executable.

agda-compile <file.agda>

agda-js

Compiles an Agda file to JavaScript.

agda-js <file.agda>

Features

  • Pretty-printed output for errors, holes, and warnings
  • Syntax highlighting in the console
  • Easy-to-use commands for common Agda operations
  • Support for compiling Agda to executables (Haskell backend)
  • Support for compiling Agda to JavaScript (JavaScript backend)
  • Interactive mode for checking and running Agda files
  • Ability to run Agda programs with IO capabilities
  • Simplified Agda output for better readability

Requirements

  • Node.js
  • Agda

License

ISC

Author

Lorenzo Battistela

Contributing

Contributions, issues, and feature requests are welcome. Feel free to check the issues page if you want to contribute.

Support

If you have any questions or need help, please open an issue in the GitHub repository.