Agda-Pkg is a tool to manage Agda libraries with extra features like
installing libraries from different kind of sources. This tool does
not modify Agda at all, it just manages systematically the directory
.agda and the files: .agda/defaults and .agda/libraries used by
Agda to locate libraries. For more information about how Agda package
system works, please read the official documentation
here.
On agda/package-index, we are
indexing some Agda libraries. To install a library run this command
agda-pkg install LibraryName. Below, you will find other ways to
install libraries.
Table of contents
- Quick Start
- Usage
- Creating a library with Agda-Pkg
- About
To install agda-pkg, you must have installed Python 3.6+ or a latter version
on your machine. In addition, the python package manager pip3 18.0+ (for python 3).
We have tested agda-pkg with Agda v2.5.4+.
To install this tool run the following command:
$ pip install agda-pkg
Now, we can run the package manager using the command agda-pkg or even
shorter just apkg.
The easiest way to install libraries is by using the package index.
agda-pkg uses a local database to maintain a register of all
libraries available in your system. To initialize the index and the
database please run the following command:
$ apkg init
Indexing libraries from https://github.com/agda/package-index.git
Note. To use a different location for your agda files defaults
and libraries, you can set up the environment variable AGDA_DIR
before run apkg as follows:
$ export AGDA_DIR=$HOME/.agda
Other way is to create a directory .agda in your directory and run
agda-pkg from that directory. agda-pkg will prioritize the .agda
directory in the current directory.
Check all the options of a command or subcommand by using the flag --help.
$ apkg --help
$ apkg install --help
Recall updating the index every once in a while using upgrade.
$ apkg upgrade
Updating Agda-Pkg from https://github.com/agda/package-index.git
If you want to index your library go to the package index and make PR.
To see all the packages available run the following command:
$ apkg list
This command also has the flag --full to display a version of the
this list with more details.
Install a library is now easy. We have multiple ways to install a package.
- from the package-index
$ apkg install standard-library
- from a local directory
$ apkg install .
or even much simpler:
$ apkg install
Installing a library creates a copy for agda in the directory assigned
by agda-pkg. If you want your current directory to be taken into
account for any changes use the --editable option. as shown below.
$ apkg install --editable .
- from a github repository
$ apkg install --github agda/agda-stdlib --version v1.1
- from a git repository
$ apkg install http://github.com/jonaprieto/agda-prop.git
To specify the version of a library, we use the flag --version
$ apkg install standard-library --version v1.0
Or simpler by using @ or == as it follows.
$ apkg install standard-library@v1.0
$ apkg install standard-library==v1.0
To install multiple libraries at once, we have two options:
- Using the inline method
$ apkg install standard-library agda-base
Use @ or == if you need a specific version, see above
examples.
- Using a requirement file:
Generate a requirement file using apkg freeze:
$ apkg freeze > requirements.txt
$ cat requirements.txt
standard-library==v1.1
Now, use the flag -r to install all the listed libraries
in this file:
$ apkg install -r requirements.txt
Check all the options of this command with the help information:
$ apkg install --help
Uninstalling a package will remove the library from the visible libraries for Agda.
- using the name of the library
$ apkg uninstall standard-library
- infering the library name from the current directory
$ apkg uninstall .
And if we want to remove the library completely (the sources and
everything), we use the flag --remove-cache.
$ apkg uninstall standard-library --remove-cache
We can get the latest version of a package from the versions registered in the package-index.
- Update all the installed libraries:
$ apkg update
- Update a specific list of libraries. If some library is not installed, this command will installed the latest version of it.
$ apkg update standard-library agdarsec
$ apkg freeze
standard-library==v1.1
This command is useful to keep in a file the versions used for your project to install them later.
$ apkg freeze > requirements.txt
To install from this requirement file run this command.
$ apkg install < requirements.txt
We make a search (approximate) by using keywords and title of the packages from the index. To perform such a search, see the following example:
$ apkg search metis
1 result in 0.0012656739999998834seg
cubical
url: https://github.com/agda/cubical.git
installed: False
$ apkg info cubical
In this section, we describe how to build a library.
To build a project using agda-pkg, we just run the following command:
$ apkg create
Some questions are going to be prompted in order to create the necessary files for Agda and for Agda-Pkg.
The output is a folder like the following showed below.
A common Agda library has the following structure:
$ tree -L 1 mylibrary/
mylibrary/
├── LICENSE
├── README.md
├── mylibrary.agda-lib
├── mylibrary.agda-pkg
├── src
└── test
2 directories, 3 files
$ cat mylibrary.agda-lib
name: mylibrary -- Comment
depend: LIB1 LIB2
LIB3
LIB4
include: PATH1
PATH2
PATH3This file only works for agda-pkg. The idea of
this file is to provide more information about the
package, pretty similar to the cabal files in Haskell.
This file has priority over its version .agda-lib.
$ cat mylibrary.agda-pkg
name: mylibrary
version: v0.0.1
author:
- AuthorName1
- AuthorName2
category: cat1, cat2, cat3
homepage: http://github.com/user/mylibrary
license: MIT
license-file: LICENSE.md
source-repository: http://github.com/user/mylibrary.git
tested-with: 2.6.0
description: Put here a description.
include:
- PATH1
- PATH2
- PATH3
depend:
- LIB1
- LIB2
- LIB3
- LIB4This is a proof of concept of an Agda Package Manager. Any contribution or feedback to improve this work is very welcomed.