IOGX is a Nix library of functions and templates for structuring your Nix code and comes with a number of common DevX facilities to help develop your project.
Make sure that you have installed and configured nix on your system.
To get started run:
# For Haskell Projects
nix flake init --template github:input-output-hk/iogx#haskell
# For Other Projects
nix flake init --template github:input-output-hk/iogx#vanillaThese will generates a flake.nix and a nix folder in your repository root.
You may now move on to the API Reference.
Define a set of GHC configurations for your Haskell project using haskell.nix's flake variants, and for each variant you will get devShells, packages, apps, checks and hydraJobs.
devShells come with an optional and complete Haskell toolchain, and they can be easily extended with new packages, custom scripts, environment variables and hooks.
By default your hydraJobs will include every component in your Haskell project, and your test suites will run in CI.
IOGX uses pre-commit-hooks to format your source tree: hooks can be easily configured and are automatically run in CI.
If your project needs a Read The Docs site then IOGX will include the necessary tools and scripts, and will add the relevant derivations to CI.
The flake.nix file and all library functions are documented in the API Reference.
In the future we plan to develop the following features:
- Hoogle Support
- Automatic Test Coverage Reports
- Automatic Benchmarking in CI
- Broken Link Detection
- Option to exclude specific jobs from the
requiredaggregated job.