astraluma / unholy Goto Github PK

View Code? Open in Web Editor NEW

3.0 1.0 1.0 123 KB

The unholy union of docker compose, neovim, and neovide

Home Page: https://unholy.readthedocs.io/

Dockerfile 0.24% Python 99.03% Just 0.73%

dev-container dev-containers docker docker-compose neovide neovim

unholy's Introduction

unholy

Cooperates with Docker Compose, injects an nvim-based container into it, and connects neovide to it.

You can call it what you'd like, but I'm going to call this union unholy.

Requirements

Unholy itself (I suggest using pipx)
Git
The Docker CLI
socat
Neovide

Usage

Commit an Unholyfile to your repo (see below)
Run unholy new <git url>
Work on your project using unholy shell and unholy neovide

Use unholy remake to rebuild your development environment without re-cloning your repo or touching your work.

Note: By default, the name of the Unholy project is the repo name.

Unholyfile

A major aspect of unholy is the Unholyfile. It is a script with TOML head matter, like so:

---
[dev]
image="python"
---
pip install pytest

The complete headmatter schema is loosely documented in core.Unholyfile.

The script supports a #!, defaulting to #!/bin/sh

If you specify a non-default image, it must be Debian-based.

Additional config

Local configuration (including project definitions) are stored in the XDG Config directory (default ~/.config/unholy).

There is a global ~/.config/unholy/Unholy applied to all projects. This is an excellent place for personal settings (like utilities you like or nvim configuration).

Each project gets an ~/.config/<name>.Unholyfile where unholy keeps git and Docker settings. You can add some local project overrides here.

unholy's People

Contributors

Stargazers

Watchers

Forkers

rhixghart

unholy's Issues

Stale socat lockfiles confuse Unholy

If socat dies unceremoniously (computer dies, kill -9, etc), it'll leave a lockfile.

When starting the agent forward, ensure the socat lockfile is still valid.

Remove command

Add a CLI command to complete blow away an unholy project.

Make sure it has all the appropriate confirmations.

Compose alias

It's annoying to call docker compose inside the devenv with the unholy settings.

Have unholy inject an alias/script of some kind to improve this.

Don't use root

Don't do everything as root. Create a user in the environment and use that for most commands.

Exec command

Add an exec CLI command to have unholy just execute a thing in the devenv.

zscaler cert

Docker Desktop for Mac now runs HTTP traffic through the system proxy. Which for $DAYJOB is zscaler with tls inspection.

Add the zscaler root cert to the container

Shell customization

Allow the user to specify a shell

Support container systems other than docker/compose

Honestly, this is half-aspirational. (What systems? Have you seen Kubernetes?)

But we should not be married to Docker+Compose forever.

Unholy new bare

Allow unholy new to create a workspace and devenv without looking at or cloning a git repo

Multi-user story

Figure out how multiple Unholy users should share one server/daemon.

Support UIs other than Neovide

There's a variety of frontends available besides Neovide. Support a few of them.

Add `--version` flag

I just did pipx install unholy, and tried unholy --version to check what version I had.

PS C:\Users\puppy> unholy --version
Usage: unholy [OPTIONS] COMMAND [ARGS]...
Try 'unholy --help' for help.

Error: No such option: --version
PS C:\Users\puppy>