https://github.com/mibmo/conch

Modules for your project environments
https://github.com/mibmo/conch

development-environment devshell nix nix-modules nix-shell

Last synced: about 1 year ago
JSON representation

Modules for your project environments

• Host: GitHub
• URL: https://github.com/mibmo/conch
• Owner: mibmo
• License: mit
• Created: 2023-04-30T15:53:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T10:22:15.000Z (over 1 year ago)
• Last Synced: 2024-07-30T13:19:40.988Z (over 1 year ago)
• Topics: development-environment, devshell, nix, nix-modules, nix-shell
• Language: Nix
• Homepage:
• Size: 73.2 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[issues]: https://github.com/mibmo/conch/issues

[issues-new]: https://github.com/mibmo/conch/issues/new

[search]: https://mibmo.github.io/conch/search

# conch 🐚

Leveraging the power of Nix modules for powerful

environment-specific shells to suit your project.

## Usage

Setting up a generic environment for working with Node is as simple as 

running `nix flake init --template github:mibmo/conch#node-pnpm` or

placing a `flake.nix` at the root of your project directory.

```nix

{

  inputs = {

    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

    conch = {

      url = "github:mibmo/conch";

      inputs.nixpkgs.follows = "nixpkgs";

    };

  };

  outputs = { conch, ... }:

    conch.load [ "x86_64-linux" ] ({ ... }: {

      development.node = {

        enable = true;

        pnpm.enable = true;

      };

    });

}

```

Entering the environment by running `nix develop`.

A full list of the modules and their options are available at [mibmo.github.io/conch/search][search]

**NOTE:** Conch's nixpkgs input should follow your own!

Otherwise things may break or in general just not work as expected.

The examples follow best practices and should be referred to.

### Missing something?

Open an [issue][issues-new]!

## Contributing

Conch is far from complete and the internals are likely to change a lot,

but contributions are always welcome! *(especially of the module variety!)*