Skip to content

A help message for development environments

License

Notifications You must be signed in to change notification settings

jtrrll/env-help

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

env-help

GitHub Actions CI Status License

A help message for development environments. A devenv module written in Nix.

Demo

Usage

  1. Import the devenvModule within a devenv configuration.

    {
      outputs = inputs: {
        devShells."x86_64-linux".default = devenv.lib.mkShell {
          inherit inputs pkgs;
          modules = [
            inputs.env-help.devenvModule
            ...
          ];
        };
        ...
      };
      ...
    }
  2. Enable env-help within a devenv configuration.

    {
      env-help = {
        enable = true;
        ...
      };
      scripts = {
       "example" = { 
         exec = ...;
         description = ...;
       };
        ...
      };
      ...
    }
  3. Run env-help to list information about the development environment.

    env-help