mission-control

A flake-parts module for your Nix devshell scripts.

Lets you configure commands that will be run in the repository root.

Provides an informative "message of the day" when launching your shell.

See the Platonic-Systems/mission-control readme.

Installation

To use these options, add to your flake inputs:

mission-control.url = "github:Platonic-Systems/mission-control";

and inside the mkFlake:

imports = [
  inputs.mission-control.flakeModule
];

Run nix flake lock and you're set.

Options

perSystem.mission-control

perSystem.mission-control.banner

perSystem.mission-control.installToDevShell

perSystem.mission-control.scripts

perSystem.mission-control.scripts.<name>.category

perSystem.mission-control.scripts.<name>.description

perSystem.mission-control.scripts.<name>.exec

perSystem.mission-control.wrapper

perSystem.mission-control.wrapperName

perSystem.mission-control

Specification for the scripts in dev shell

Type: submodule

Default: { }

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.banner

The generated shell banner.

Type: string

Default: generated package

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.installToDevShell

Override the given devshell’s shellHook and nativeBuildInputs to add the banner and the wrapper script.

Type: function that evaluates to a(n) raw value

Default: <function>

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.scripts

List of scripts to be added to the shell

Type: attribute set of (submodule)

Default: { }

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.scripts.<name>.category

The category under which this script will be gropuped.

Type: string

Default: "Commands"

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.scripts.<name>.description

A description of what this script does.

This will be displayed in the banner and help menu.

Type: null or string

Default: null

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.scripts.<name>.exec

The script or package to run

Type: string or package

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.wrapper

The generated wrapper script.

Type: package

Default: generated package

Declared by:

mission-control/nix/flake-module.nix

perSystem.mission-control.wrapperName

The name of the wrapper script

Type: string

Default: ","

Declared by:

mission-control/nix/flake-module.nix