Home

Awesome

Organist

Control all your tooling from a single console

Managing a project's development environment involves configuring a lot of tools and occasionally getting to communicate with each other: one (or several) package managers, a CI system, a service manager (to run that local postgresql database without which you can't test anything), custom utility scripts that end up spawning everywhere, etc. Organist aims at being your main entrypoint for managaing all these different tools, so that you can get:

  1. A unified configuration framework for all of these
  2. A powerful and ergonomic language to allow you to easily abstract over these configurations, with discoverability and early error reporting

Getting started

To start using Organist, you need Nix to be installed and configured. If it isn't already the case, you can get it with:

curl -L https://nixos.org/nix/install | bash
# We also need a couple of experimental Nix features
mkdir -p ~/.config/nix
echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf

Then bootstrap a project with:

nix flake init -t github:nickel-lang/organist
# Edit the project file to fit your needs
$EDITOR project.ncl
# Enter the environment
nix develop

It is also possible to use Organist without flakes, see doc/bootstrap-no-flake.md

Managing your dependencies with organist

Organist can be used to declare the dependencies for your project. These can then be instantiated using Nix.

More information on doc/dependency-management.md.

Generating files

Development projects tend to require a lot of boilerplaty files to configure all the tools involved. Organist can take care of these through the files option

Managing services

Organist also allows you to declare a set of services that need to be running when developing your project, through the services option

How does this differ from {insert your favorite tool} ?