Skip to content

Options

enterShellCommands

Commands to run when entering the shell.

Type:

attribute set of (submodule)

Default value:

{ }

Example value:

{
  hello = {
    text = "echo Hello world";
  };
}

Declared in:

enterShellCommands.<name>.deps

A list of other steps that this one depends on.

Type:

list of string

Default value:

[ ]

Declared in:

enterShellCommands.<name>.text

Script to run.

Type:

string

Declared in:

env

Manage environment variables.

Type:

attribute set of (submodule)

Default value:

{ }

Declared in:

env.<name>.description

Description of the env var, can be shown in the menu.

Type:

null or string

Default value:

null

Declared in:

env.<name>.eval

Like value but evaluated by Bash. This allows to inject other variable names or even commands using the $() notation.

Type:

null or string

Default value:

null

Example value:

"$OTHER_VAR"

Declared in:

env.<name>.name

Name of the environment variable, usually already set to <name>.

Type:

string

Default value:

"‹name›"

Declared in:

env.<name>.prefix

Prepend to PATH-like environment variables.

For example name = "PATH"; prefix = "bin"; will expand the path of ./bin and prepend it to the PATH, separated by :.

Type:

null or string

Default value:

null

Example value:

"bin"

Declared in:

env.<name>.unset

Unset the env variable.

Type:

boolean

Default value:

false

Declared in:

env.<name>.value

Any value to convert to a string and set the env variable to. There is no evaluation of the value, for that see eval.

Type:

null or string or signed integer or boolean or package

Default value:

null

Example value:

"hello"

Declared in:

env.<name>.visible

Whether to include this env var and it's description in the menu.

Type:

boolean

Default value:

false

Declared in:

interactiveShellCommands

Commands to run when entering an interactive shell.

Type:

attribute set of (submodule)

Default value:

{ }

Example value:

{
  hello = {
    text = "echo Hello world";
  };
}

Declared in:

interactiveShellCommands.<name>.deps

A list of other steps that this one depends on.

Type:

list of string

Default value:

[ ]

Declared in:

interactiveShellCommands.<name>.text

Script to run.

Type:

string

Declared in:

meta.description

Type:

string

Default value:

"Welcome to the devshell."

Declared in:

meta.enableMenu

Add a menu command which shows a nice overview/summary of the devshell.

Type:

boolean

Default value:

true

Declared in:

meta.entries

(no description)

Type:

attribute set of (submodule)

Default value:

{ }

Declared in:

meta.entries.<name>.description

(no description)

Type:

null or string

Default value:

null

Declared in:

meta.entries.<name>.name

(no description)

Type:

string

Default value:

"‹name›"

Declared in:

meta.entries.<name>.section

(no description)

Type:

string

Default value:

"general"

Declared in:

meta.entries.<name>.subEntries

(no description)

Type:

attribute set

Default value:

{ }

Declared in:

meta.sections

(no description)

Type:

attribute set of (submodule)

Default value:

{
  general = { };
}

Declared in:

meta.sections.<name>.color

(no description)

Type:

null or string

Default value:

"blue"

Declared in:

meta.sections.<name>.name

(no description)

Type:

string

Default value:

"‹name›"

Declared in:

meta.showMenu

When to show the devshell menu. once uses a state file in $REN_STATE to keep track of the first time.

Type:

one of "always", "once", "never"

Default value:

"once"

Declared in:

name

Name of the shell.

Type:

string

Default value:

"devshell"

Declared in:

packages

Packages to install into the devshell.

Type:

list of package

Default value:

[ ]

Declared in: