Fast, Declarative, Reproducible and Composable - Developer Environments using Nix
-- Develop natively - • Deploy containers - • 100.000+ packages - • Write scripts and - tasks - • 50+ supported languages - • Define processes - • Reuse services - • Run tests - • Enforce git hooks -
-+ Fast, Declarative, Reproducible and Composable Developer + Environments using Nix +
++ Develop + natively + • Deploy + containers + • 100.000+ + packages + • Write + scripts + and + tasks + • 50+ + supported languages + • Define + processes + • Reuse + services + • Run + tests • + Enforce + git hooks +
+Simple JSON-like language
-- Declaratively define your development environment by toggling basic options. -
-
-
- - Environment variables. - -
-
- Use
envattribute set to define environment variables. - -If you'd like to also include secrets from
-.env- file, setdotenv.enable = true;.
- - - Packages. - -
- - Pick from 80000+ prebuilt packages for - Linux/macOS and X64/Arm64. Works with WSL2. -
- - Run script(s) when entering the environment. - -
- - Prepare your environment when entering the shell that has environment already loaded. - -
- - Automatically load the environment when entering the project. - -
-
- Using
direnvwill automatically load the environment when you enter the project - directory. -
-
+ Simple JSON-like language +
++ Declaratively define your development environment by + toggling basic options. +
+ +-
+
- + Environment variables. + +
-
+ Use
+
env+ attribute set to define environment variables. + ++ If you'd like to also include secrets from +
+.env+ file, set +dotenv.enable = true;. +
+ - + Packages. + +
- + Pick from + 80000+ prebuilt packages for + Linux/macOS and + X64/Arm64. Works with + WSL2. + +
- + Run script(s) when entering the environment. + +
- + Prepare your environment when entering the shell + that has environment already loaded. + +
- + Automatically load the environment when entering + the project. + +
-
+ Using
+
direnvwill + automatically load the environment when you + enter the project directory. +
+
{ pkgs, config, ... }: {
+ { pkgs, config, ... }: {
env.GREET = "determinism";
packages = [
@@ -124,37 +188,49 @@ Fast, Decla
'';
}
devenv shell
+
+ devenv shell
hello determinism
ncdu 2.3
-
+ { pkgs, ... }: {
+
+
+
+
+
+
+
+
+
+ devenv.nix
+
+
+
+ { pkgs, ... }: {
packages = [ pkgs.yarn ];
scripts.build.exec = "yarn build";
@@ -176,11 +252,15 @@ Fast, Decla
};
}
-
-
+
+
-
-devenv shell
+
+ devenv shell
...
Running tasks devenv:enterShell
Succeeded devenv:git-hooks:install 15ms
@@ -190,68 +270,114 @@ Fast, Decla
$
-
-
-
-
-
-
- Scripts and Tasks
-
- Define scripts, tasks and
- git hooks
- to automate your development workflow.
-
-
- -
- Scripts.
-
- -
- Define scripts that can be invoked inside the environment, using all the packages and environment
- variables.
-
-
-
- -
- Tasks.
-
- -
- Form dependencies between automation code, executed in parallel and written in your favorite language.
-
+
+
-
-
- Git hooks.
-
-
- Pick from builtin and language specific linters and formatters using git-hooks.nix.
+
+
+
+
+ Scripts and Tasks
+
+
+ Define
+ scripts,
+ tasks
+ and
+ git hooks
+ to automate your development workflow.
+
+
+
+
+ -
+ Scripts.
+
+ -
+ Define scripts that can be invoked inside the
+ environment, using all the packages and
+ environment variables.
+
+
+
+ -
+ Tasks.
+
+ -
+ Form dependencies between automation code,
+ executed in parallel and written in your
+ favorite language.
+
+
+
+ -
+ Git hooks.
+
+ -
+ Pick from builtin and language specific linters
+ and formatters using
+ git-hooks.nix.
+
+
+
+
-
-
devenv search devenv
+
+
+
+ devenv search devenv
+--------------+---------------+------------------------------------------------------------------------+
| Package | Version | Description |
+--------------+---------------+------------------------------------------------------------------------+
@@ -268,60 +394,91 @@ Fast, Decla
+--------------------------+---------+-----------+------------------------------------------------------------+
• Found 1 package and 3 options for 'devenv'.
-
+
+
+ Languages
-- Supports over 50 programming languages. -
-
-
- - Packed with tooling. - -
- - Comes with commonly used tooling for each language. Including LSP servers, formatters, linters, and - compilers. - -
- - Version support. - -
- - Languages like Python, Terraform, Rust, PHP and Ruby all have version support. -
- - Examples - -
- - Checkout examples collection - to get started. -
+ Languages +
++ Supports over 50 + programming languages. +
+ +-
+
- + Packed with tooling. + +
- + Comes with commonly used tooling for each + language. Including LSP servers, formatters, + linters, and compilers. + +
- + Version support. + +
- + Languages like Python, Terraform, Rust, PHP and + Ruby all have version support. + +
- + Examples + +
- + Checkout + examples collection + to get started. + +
{ pkgs, config, ... }: {
+ { pkgs, config, ... }: {
languages.python = {
enable = true;
version = "3.11";
@@ -354,140 +511,208 @@ Fast, Decla
};
}
{ pkgs, ... }: {
- packages = [
- pkgs.mkdocs
- pkgs.watchexec
- ];
+
+
+
+
+
+
+
+
+
+ devenv.nix
+
+
+
+ { pkgs, ... }: {
+ packages = [
+ pkgs.cargo-watch
+ ];
- processes = {
- docs.exec = "mkdocs serve";
- tailwind.exec = "watchexec -e html,css,js npx tailwindcss build extra.css -o output.css";
- };
+ processes = {
+ cargo-watch.exec = "cargo watch -x run";
+ };
}
-
-
+
+
-
-devenv up
+
+ devenv up
• Building processes ...
• Starting processes ...
...
-
-
-
-
-
-
- Run processes
-
- Define your processes in a declarative way
- and start them with devenv up.
-
-
- -
- Processes
-
- -
- Inspired by
Procfile, declare development processes that have
- access to your environment.
-
+
+
-
-
- process-compose
-
-
- By default process-compose is used to manage processes,
- giving you a
- simple interface to inspect logs and restart processes (ctrl-r).
- 
+
+
+
+
+ Run processes
+
+
+ Define your
+ processes in a declarative way
+ and start them with
+ devenv up.
+
+
+
+
+ -
+ Processes
+
+ -
+ Inspired by
+
Procfile,
+ declare development processes that have access
+ to your environment.
+
+
+
+ -
+ process-compose
+
+ -
+ By default
+ process-compose
+ is used to manage processes, giving you a simple
+ interface to inspect logs and restart processes
+ (ctrl-r).
+
+
+
+
+
-
-
Run services
-- Pick from a number of community maintained - services like PostgreSQL, Redis, MySQL, - RabbitMQ, WireMock, MinIO, Caddy, ElasticSearch, OpenTelemetry Collector, and more are being added each day. -
-
-
- - Pre-configured processes - -
-
- Services define processes that are started when the service is enabled as part of
devenv up. -
- - - Configuration - -
- - Each service provides a number of options how to configure it and a hook to pass extra configuration, - whatever the format. -
- - Extendable - -
- - Define your development processes as a service, allowing reuse and simplicity of a few lines of - configuration. - -
+ Run services +
++ Pick from a number of community maintained + services + like + PostgreSQL, Redis, MySQL, RabbitMQ, WireMock, + MinIO, Caddy, ElasticSearch, OpenTelemetry + Collector, and + more are being added + each day. +
+ +-
+
- + Pre-configured processes + +
-
+ Services define processes that are started when
+ the service is enabled as part of
+
devenv up. +
+ - + Configuration + +
- + Each service provides a number of options how to + configure it and a hook to pass extra + configuration, whatever the format. + +
- + Extendable + +
- + Define your development processes as a service, + allowing reuse and simplicity of a few lines of + configuration. + +
{ pkgs, ... }: {
+ { pkgs, ... }: {
services.postgres = {
enable = true;
package = pkgs.postgresql_15;
@@ -501,35 +726,48 @@ Fast, Decla
};
}
devenv up
+
+ devenv up
...
-
+ { pkgs, ... }: {
+
+
+
+
+
+
+
+
+
+ devenv.nix
+
+
+
+ { pkgs, ... }: {
packages = [
pkgs.mkdocs
pkgs.curl
@@ -546,98 +784,162 @@ Fast, Decla
}
-
-
+
+
-
-devenv test
+
+ devenv test
...
-
-
-
-
-
-
- Run tests
-
- Running a script inside your development environment
- with all processes running should be as simple as devenv test.
-
-
- -
- enterTest
-
- -
- Execute your favorite language test runner or a simple script to verify your environment.
-
-
All process management is taken care for you.
-
+
+
+
+
+
+
+
+ Run tests
+
+
+ Running
+ a script inside your development environment with
+ all processes running
+ should be as simple as
+ devenv test.
+
+
+
+
+ -
+ enterTest
+
+ -
+ Execute your favorite language test runner or a
+ simple script to verify your environment.
+
+
+ All process management is taken care for
+ you.
+
+
+
+
+
-
- Container interoperability
-- Generate containers from your development - environment and build/copy/run them. -
-
-
- - Containerize your environment. - -
-
-
shellcontainer allows you to run your environment in a container. - -Use
-devenv container run shellto enter your - environment in a container.
- - - Containerize your processes. - -
-
-
processescontainer allows you to run your processes in a - container. - -Use
-devenv container run processesto run your - processes in a container. - - Custom containers. - -
-
- Define
containers.mycontainer.*to customize your container. -
- - + Containerize your environment. + +
-
+
shell+ container allows you to run your environment in + a container. + ++ Use +
+devenv container run shell+ to enter your environment in a container. +
+ - + Containerize your processes. + +
-
+
processes+ container allows you to run your processes in a + container. + ++ Use +
+devenv container run processes+ to run your processes in a container. +
+ - + Custom containers. + +
-
+ Define
+
containers.mycontainer.*+ to + customize your container. +
+
+ Container interoperability +
++ Generate containers + from your development environment and build/copy/run + them. +
- --
+
{ pkgs, ... }: {
+ { pkgs, ... }: {
packages = [
pkgs.mkdocs
pkgs.curl
@@ -649,11 +951,15 @@ Fast, Decla
}
devenv container build processes
+
+ devenv container build processes
...
devenv container copy processes
...
@@ -661,27 +967,36 @@ Fast, Decla
...
-
+ inputs:
+
+
+
+
+
+
+
+
+
+ devenv.yaml
+
+
+
+ inputs:
myorg-devenv:
url: github:myorg/myorg-devenv
imports:
@@ -690,53 +1005,75 @@ Fast, Decla
- myorg-devenv/service1
- myorg-devenv/service2
+
+
+
-
-
- Poly/Mono repo composability
-- Compose multiple environments - into a single environment. -
-
-
- - Local imports - -
- - If you're working on a monorepo, define environment per folder and import them to merge them into a - single environment. - -
- - Remote imports - -
-
- If you're working on a polyrepo, define environment per repository and import them to merge them into a
- single environment.
-
-
A great way to get started is to use central repository with all the shared - configuration until your team is comfortable - maintaining their own environments.
+ ++-++ Poly/Mono repo composability +
++ Compose multiple environments + into a single environment. +
+ +-
+
- + Local imports + +
- + If you're working on a monorepo, define + environment per folder and import them to merge + them into a single environment. + +
- + Remote imports + +
-
+ If you're working on a polyrepo, define
+ environment per repository and import them to
+ merge them into a single environment.
+
+
+ A great way to get started is to use central + repository with all the shared configuration + until your team is comfortable maintaining + their own environments. +
+
+
++++
Built by
-
+ Built by
+