Skip to content

Getting started

Installation

  1. Install Nix.

    Tip

    We recommend getting the Multi-user installation for compatibility.

  2. Install Makes:

    1
    nix-env -if https://github.com/fluidattacks/makes/archive/24.12.tar.gz

Quickstart

  1. Create a makes.nix file in your project root:

    1
2
3
4
5
6
7
8
    { makeScript, ...}: {
  jobs = {
    "/helloWorld" = makeScript {
      name = "helloWorld";
      entrypoint = "echo 'Hello World!'";
    };
  };
}

  2. Invoke it with the m command while standing in the project root:

    1
    m . /helloWorld

  3. Explore Essentials and Core functions for more complex cases like creating production/development environments, and CI/CD jobs.

  4. Explore CLI and Container for invoking makes in different scenarios and environments.

Importing via Nix

You can also import Makes from Nix:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
let
  # Import the framework
  makes = import "${builtins.fetchTarball {
    sha256 = ""; # Tarball sha256
    url = "https://api.github.com/repos/fluidattacks/makes/tarball/24.12";
  }}/src/args/agnostic.nix" { };
in
# Use the framework
makes.makePythonEnvironment {
  pythonProjectDir = ./.;
  pythonVersion = "3.11";
}

For a detailed list of available utilities check out Makes' agnostic args.