ashermancinelli / devenv

Environment manager for consistent development

Devenv - Manager for Complex Development Environments

To get started, just add ./bin to your PATH.

devenv has a few subcommands:

$ devenv help
usage: devenv [--config-file CONFIG_FILE] [--help]
              {help,edit,list,apply,version,status,describe,update} ...

Configure development environment based on predetermined configurations

positional arguments:
  {help,edit,list,apply,version,status,describe,update}
                        sub-command --help

optional arguments:
  --config-file CONFIG_FILE, -c CONFIG_FILE
                        Path to configuration file. Defaults to ~/.devenv.yaml
  --help, -h            View all program options

--------------------------------------------------------------------------------

Help for subcommand "help"
------------------------------
usage: devenv help [--verbose] [--debug]

optional arguments:
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "edit"
------------------------------
usage: devenv edit [-h] [--verbose] [--debug]

optional arguments:
  -h, --help     show this help message and exit
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "list"
------------------------------
usage: devenv list [-h] [--verbose] [--debug]

optional arguments:
  -h, --help     show this help message and exit
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "apply"
------------------------------
usage: devenv apply [-h] [--export EXPORT] [--verbose] [--debug] name

positional arguments:
  name                  Name of configuration to be applied.

optional arguments:
  -h, --help            show this help message and exit
  --export EXPORT, -e EXPORT
                        Environment variables to set in target environment of
                        the form --export var1=var,var2 where var1 is set to
                        "var", and var2 is set to the value of var2 in host
                        environment.
  --verbose, -v         Verbose debugging information
  --debug, -L           Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "version"
------------------------------
usage: devenv version [--verbose] [--debug]

optional arguments:
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "status"
------------------------------
usage: devenv status [-h] [--verbose] [--debug]

optional arguments:
  -h, --help     show this help message and exit
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "describe"
------------------------------
usage: devenv describe [-h] [--verbose] [--debug] [name]

positional arguments:
  name           Name of environment to be described. If not supplied, the
                 entire configuration will be described.

optional arguments:
  -h, --help     show this help message and exit
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Help for subcommand "update"
------------------------------
usage: devenv update [-h] [--verbose] [--debug]

optional arguments:
  -h, --help     show this help message and exit
  --verbose, -v  Verbose debugging information
  --debug, -L    Extra verbose debugging information

--------------------------------------------------------------------------------

Configuration Format

The configuration files must have the following form:

# ~/.devenv.yaml
devenv:
  environments:
      environment-name:
          commands:
            - cd ~/myproject
          modules:
            - gcc/7.5.0
          launch-command: bash

  aliases:
      alias1: value1

The commands are built in the following order:

1. Exported variables from command line if --export flag is passed
2. Commands
3. Modules
4. Launch Command

For example, the following config:

# ~/.devenv.yaml
configs:
    myconfig:
        commands:
          - cd ~/workspace
        modules:
          - gcc/7.4.0
        launch-command: 'srun -N 1 --pty bash'

aliases:
    c: myconfig

would invoke the following command in a subshell:

$ cd ~/workspace
$ module load gcc/7.4.0
$ srun -N 1 --pty bash

This development environment may be invoked either via devenv -n myconfig or devenv -n c.

Subcommands

Dump

devenv dump simply pretty-prints all information about valid development environments currently configured.

List

devenv list lists the names of all the valid development environments currently configured.

Apply

devenv apply <name> applies the development environment given by name.

The --export EXPORT flag (eg devenv apply <name> --export) is meant to replicate slurm's exporting functionality. For example:

$ devenv apply myenv --export key1=value1,key2

would result in the following bash commands prefixing the rest of the commands:

$ export key1=value1
$ export key2=<whatever the value of key2 was on the host system>

For example:

$ export key2='value on host'
$ ./bin/devenv apply t --export key1=value1,key2
$ echo $key1
value1
$ echo $key2
value on host