xen/dev:latest

A modern portable sandboxed terminal-based vim-centric development environment.

Overpowered "dotfiles" intended to run in a number of ways; either within a:

customized sandboxed gpu-accelerated terminal (recommended)
x11docker-powered full, but minimal, desktop (interesting)
terminal of your choice (minimal requirements)

Note: Developed on and for Linux; other host compatibility is unknown.

Quickstart

mkdir ~/src && cd ~/src
git clone https://github.com/xendarboh/xendev.git
cd xendev
cp .env-example .env
# edit .env to enable optionals or set specific versions
make build
./xendev

Tools

Neovim: Vim-fork focused on extensibility and usability
- LunarVim: An IDE layer for Neovim. Completely free and community driven (INSTALL_LUNARVIM)
  - better-escape.nvim: Escape from insert mode without delay when typing
  - copilot-cmp: Lua plugin to turn github copilot into a cmp source
  - copilot.lua: Fully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot
  - markdown-preview.nvim: Markdown preview plugin for (neo)vim
  - marksman: Write Markdown with code assist and intelligence in the comfort of your favourite editor
  - neoscroll.nvim: Smooth scrolling neovim plugin written in lua
  - smart-splits.nvim: Smart, seamless, directional navigation and resizing of Neovim + terminal multiplexer splits
- SpaceVim: A community-driven modular vim/neovim distribution - The ultimate vimrc (INSTALL_SPACEVIM)
  - coc.nvim: Conquer of Completion; Make your Vim/Neovim as smart as VSCode
- neovim-remote: Support for --remote and friends
Nix: Nix, the purely functional package manager (INSTALL_NIX)
Node.js: Node.js JavaScript runtime
- pnpm: Fast, disk space efficient package manager
- yarn: Fast, reliable, and secure dependency management
- fnm: Fast and simple Node.js version manager, built in Rust
- npm-check-updates: Find newer versions of package dependencies than what your package.json allows
- npm-check: Check for outdated, incorrect, and unused dependencies
AWS CLI v2: enables interaction with AWS services. (INSTALL_DEVOPS)
Ansible: a radically simple IT automation system (INSTALL_DEVOPS)
OpenTofu: declaratively manage your cloud infrastructure (INSTALL_DEVOPS)
Tomb: the Crypto Undertaker (INSTALL_TOMB)
circom: zkSnark circuit compiler (INSTALL_CIRCOM)
cpanminus: get, unpack, build and install modules from CPAN
cypress: (deps) Fast, easy and reliable testing for anything that runs in a browser (INSTALL_CYPRESS_DEPS)
deno: A modern runtime for JavaScript and TypeScript
diff-so-fancy: Good-lookin' diffs. Actually… nah… The best-lookin' diffs
exa: A modern replacement for ‘ls’
fastmod: A tool to assist with large-scale codebase refactors
fish-shell: The user-friendly command line shell
- fisher: A plugin manager for Fish
- fish-exa: exa aliases for fish
- fish-gruvbox: gruvbox theme for fish
- fish-nx: Fish completions for Nx
- nix-env.fish: Nix environment setup for the fish shell (INSTALL_NIX)
fleek-cli: Use Fleek to deploy websites and apps on the open web: permissionless, trustless, censorship resistant, and free of centralized gatekeepers
fzf: A command-line fuzzy finder
git (latest stable version)
- gh: GitHub’s official command line tool
- git-absorb: git commit --fixup, but automatic
- git-crypt: [fork] Transparent file encryption in git
- git-filter-repo: Quickly rewrite git repository history (filter-branch replacement)
  - gfr-bfg-ish: A re-implementation of most of BFG Repo Cleaner, with new features and bug fixes
  - gfr-clean-ignore: Delete files from history which match current gitignore rules
  - gfr-insert-beginning: Add a new file (e.g. LICENSE/COPYING) to the beginning of history
  - gfr-lint-history: Run some lint command on all non-binary files in history
  - gfr-signed-off-by: Add a Signed-off-by tag to a range of commits
- git-lfs: Git extension for versioning large files
- lazygit: Simple terminal UI for git commands
go: The Go programming language
import-js: A tool to simplify importing JS modules
jq: Command-line JSON processor
kpcli: A command line interface for KeePass
llvm-project: (clang) A collection of modular and reusable compiler and toolchain technologies (INSTALL_LLVM)
ncdu: NCurses Disk Usage
ninja-build: A small build system with a focus on speed
platformio-core: A professional collaborative platform for embedded development
prettier: Prettier is an opinionated code formatter
protobuf: Protocol Buffers - Google's data interchange format (INSTALL_PB)
- buf: A new way of working with Protocol Buffers
ranger: A VIM-inspired filemanager for the console
ripgrep: recursively searches directories for a regex pattern while respecting your gitignore
rustup: The Rust toolchain installer
silversearcher-ag: A code-searching tool similar to ack, but faster
solidity: Solidity, the Smart Contract Programming Language
- solc-js: Javascript bindings for the Solidity compiler
spacer: CLI tool to insert spacers when command output stops
sqlite: a small, fast, self-contained, high-reliability, full-featured, SQL database engine
starship: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
stow: a symlink farm manager
taskbook: Tasks, boards & notes for the command-line habitat
tmux: A terminal multiplexer
- tpm: Tmux Plugin Manager
- tmux-gruvbox: Gruvbox color scheme for Tmux
- tmux-resurrect: Persists tmux environment across system restarts
- tmux-window-name: A plugin to name your tmux windows smartly
ts-lehre: Generate document block(JsDoc, EsDoc, TsDoc) from source code
watchman: Watches files and records, or triggers actions, when they change
- watchman-make: A convenience tool to automatically invoke a command in response to files changing
- watchman-replicate-subscription: Replicates an existing watchman subscription
- watchman-wait: Waits for changes to files, suitable for waiting from shell scripts
xclip: Command line interface to the X11 clipboard
zoxide: A smarter cd command

Additionally (and optionally), the following are within the X11 base image:

Xfce: A lightweight desktop environment for UNIX-like operating systems. It aims to be fast and low on system resources, while still being visually appealing and user friendly.
kitty: Cross-platform, fast, feature-rich, GPU based terminal
- kitty-gruvbox-theme: Gruvbox theme for kitty terminal
ImageMagick: Software suite for displaying, converting, and editing raster image and vector image files
nerd-fonts: Developer targeted fonts with a high number of glyphs (icons)
- Hack: A typeface designed for source code

Powered-by:

x11docker: Run GUI applications and desktops in docker and podman containers. Focus on security.
Xendarboh: An Elven Tech Wizard

Build

Host Requirements

docker or podman
docker compose
x11docker (not required for tty-only)
- x11docker gpu support
make (or manually run the commands in Makefile)

Configure

Edit .env to set specific versions and optional installations.

Build Image(s)

Build the full image with X11 support

make build

Or build the tty-only image

make build-tty

See all make commands

❯ make                                                                                                                                                                                                        2023-01-21 14:02:33
help                 print this help message with some nifty mojo
build                build docker image with X11 support
rebuild              rebuild docker image with X11 support
build-tty            build tty-only docker image
rebuild-tty          (re)build tty-only docker image with --no-cache --pull

Run Examples

Within a gpu-accelerated terminal

This is the recommended mode of operation with balance of sandboxed environment and host integration for optimal DX.

x11docker --gpu --clipboard --network -- xen/dev kitty

Within an x11docker-powered desktop

This mode illustrates interesting capabilities provided by x11docker with a fullly operational sandboxed desktop running within a window on the host.

x11docker --desktop --gpu --clipboard --network -- xen/dev

Within a terminal of your choice

Without X11

This is the mode of minimal host requirements, only docker|podman. It will work on a headless server, for example. Refer to xendev.tty as an example for mapping volumes from the host.

make build-tty
./xendev.tty

This also works with make build, just larger docker image.

with X11

In this mode, host clipboard will work with enhanced security provided by x11docker.

x11docker --tty --interactive --clipboard --network -- xen/dev

Host terminal expectations, ideally:
- truecolor support (use scripts in test/ to test support inside xendev)
- patched font like one from nerd-fonts with powerline symbols

With directories shared from the host

See the xendev launcher script for a functional example that shares the host user's ssh, gpg, and git config with the container and provides writeable access to ~/src.

Note: Some applications need more privileges or capabilities than x11docker provides by default; refer to the x11docker docs on privilege checks.

Preferences & Philosophy

modern latest greatest terminal utilities and versions
default to current LTS versions
FROM ubuntu:latest
vi-style key bindings
dark gruvbox color scheme
LOCALE=en_US.UTF-8 (overridden by x11docker)
analog choice of sandboxed security vs function

Tests

See the shell scripts within the test directory for tests to confirm host-mapped gpg support, terminal font rendering (truecolor, glyphs, italics) capabilities, etc.

Customization & Notes

See conf/ files.

git

To include xendev git config without replacing the local, add the following to ~/.config/git/config:

[includeIf "gitdir:/home/xendev"]
  path = ~/src/xendev/conf/gitconfig

facilitates same git config on host and within xendev container
only applied to git commands run within /home/xendev/
recommendation is to share source between host/container with volume-mapped ~/src/

Watchman

By default, watchman will watch all files and this can cause issue (such as vim lsp/coc types failing), for example if watching node_modules, so configure it per project as needed. See /usr/share/.watchmanconfig for an example.

Lunarvim

markdown-preview
- :MarkdownPreview start the preview, see URL
- :MarkdownPreviewStop stop the preview

Local (machine-specific) Configuration

This configuration remains outside the image and is volume-mapped into the container at runtime.

cp -a conf.local-example conf.local

conf.local/bash.sh
- sourced by bash; use to set custom environment like GH_TOKEN
conf.local/directory_map.txt
- a list of from:to directory mappings to preserve current working directory in new tmux windows (since tmux does not handle symlinked directories well)
conf.local/lvim.lua
- sourced by lunarvim's config.lua
conf.local/wakatime.cfg
- for wakatime or wakapi
- to enable vim-wakatime plugin within lunarvim, place the following in .conf/local/lvim.lua:
```
table.insert(lvim.plugins, {
  "wakatime/vim-wakatime",
})
```

SpaceVim + CoC (autocompletion)

Configuration Location	Purpose
conf/.config/SpaceVim.d/coc-settings.json	coc settings
conf/.config/SpaceVim.d/init.toml	enable coc as spacevim autocomplete
conf/.config/SpaceVim.d/autoload/myspacevim.vim	set coc home
Dockerfile	install coc extensions with nvim

xendarboh / xendev