Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cachix/devenv
Fast, Declarative, Reproducible, and Composable Developer Environments
https://github.com/cachix/devenv
developer-tools development-environment
Last synced: about 1 month ago
JSON representation
Fast, Declarative, Reproducible, and Composable Developer Environments
- Host: GitHub
- URL: https://github.com/cachix/devenv
- Owner: cachix
- License: apache-2.0
- Created: 2022-10-22T20:10:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T10:57:54.000Z (7 months ago)
- Last Synced: 2024-04-14T01:06:48.091Z (7 months ago)
- Topics: developer-tools, development-environment
- Language: Nix
- Homepage: https://devenv.sh
- Size: 2.63 MB
- Stars: 3,364
- Watchers: 28
- Forks: 243
- Open Issues: 256
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- stars - cachix/devenv
- my-awesome-list - devenv
- awesome-repositories - cachix/devenv - Fast, Declarative, Reproducible, and Composable Developer Environments (Nix)
- awesome-nix - devenv - A Nix-based tool for creating developer shell environments quickly and reproducibly. (Command-Line Tools / Discovery)
README
# [devenv.sh](https://devenv.sh) - Fast, Declarative, Reproducible, and Composable Developer Environments
[](https://builtwithnix.org)
[](https://discord.gg/naMgvexb6q)
[](https://github.com/cachix/devenv/releases)
[](https://github.com/cachix/devenv/actions/workflows/buildtest.yml?branch=main)
Running ``devenv init`` generates ``devenv.nix``:
```nix
{ pkgs, ... }:
{
# https://devenv.sh/basics/
env.GREET = "devenv";
# https://devenv.sh/packages/
packages = [ pkgs.git ];
enterShell = ''
hello
'';
# https://devenv.sh/tests/
enterTest = ''
echo "Running tests"
git --version | grep --color=auto "${pkgs.git.version}"
'';
# https://devenv.sh/languages/
languages.nix.enable = true;
# https://devenv.sh/scripts/
scripts.hello.exec = "echo hello from $GREET";
# https://devenv.sh/services/
services.postgres.enable = true;
# https://devenv.sh/pre-commit-hooks/
pre-commit.hooks.shellcheck.enable = true;
# https://devenv.sh/processes/
processes.ping.exec = "ping localhost";
}
```
And ``devenv shell`` activates the environment.
## Commands
```
$ devenv
https://devenv.sh 1.0.1: Fast, Declarative, Reproducible, and Composable Developer Environments
Usage: devenv [OPTIONS]
Commands:
init Scaffold devenv.yaml, devenv.nix, .gitignore and .envrc.
shell Activate the developer environment. https://devenv.sh/basics/
update Update devenv.lock from devenv.yaml inputs. http://devenv.sh/inputs/
search Search for packages and options in nixpkgs. https://devenv.sh/packages/#searching-for-a-file
info Print information about this developer environment.
up Start processes in the foreground. https://devenv.sh/processes/
processes Start or stop processes.
test Run tests. http://devenv.sh/tests/
container Build, copy, or run a container. https://devenv.sh/containers/
inputs Add an input to devenv.yaml. https://devenv.sh/inputs/
gc Deletes previous shell generations. See http://devenv.sh/garbage-collection
build Build any attribute in devenv.nix.
version Print the version of devenv.
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose
Enable debug log level.
-j, --max-jobs
Maximum number of Nix builds at any time. [default: 8]
-j, --cores
Maximum number CPU cores being used by a single build.. [default: 2]
-s, --system
[default: x86_64-linux]
-i, --impure
Relax the hermeticity of the environment.
-c, --clean [...]
Ignore existing environment variables when entering the shell. Pass a list of comma-separated environment variables to let through.
-d, --nix-debugger
Enter Nix debugger on failure.
-n, --nix-option
Pass additional options to nix commands, see `man nix.conf` for full list.
-o, --override-input
Override inputs in devenv.yaml.
-h, --help
Print help
```
## Documentation
- [Getting Started](https://devenv.sh/getting-started/)
- [Basics](https://devenv.sh/basics/)
- [Roadmap](https://devenv.sh/roadmap/)
- [Blog](https://devenv.sh/blog/)
- [`devenv.yaml` reference](https://devenv.sh/reference/yaml-options/)
- [`devenv.nix` reference](https://devenv.sh/reference/options/)
- [Contributing](https://devenv.sh/community/contributing/)