No startup pitches, I am a DevOps principled environment bootstrapper.
- Work must finish by running one command. Mouse is not productivity.
- Does not install 10s of tools most of which can be run ad-hoc in a container.
- 95% consistent user experience both on macOS and common Linux distros.
- Has an obvious (one) way to manage programming languages and tool versions.
- Provides AI agents to automate tasks requiring web browser and computer use.
 |
|---|
A few features:
- One character
.aliases: The fastest are the commands one does not type. - Terminal is mostly Rust and Go for speed, use
nix-shells for ad-hoc CLIs. - Seamless macOS Docker experience, like it was when Docker Desktop was free.
- Run
upto upgrade every package manager at once but respect locked versions. - Quickly ask AI (
a <question>) or open a specialized agent (_ <name>).
Works on macOS Tahoe (26), Sequoia (15) and Sonoma (14) on Apple Silicon.
Supported Linux distributions (both AArch64 and x86-64):
- Ubuntu Linux 24.04 LTS (Noble Numbat) and 22.04 LTS (Jammy Jellyfish)
- Debian Linux 13 (Trixie) and 12 (Bookworm)
- Fedora Linux 43 and 42
- CentOS Stream 10 and 9
- AlmaLinux 10 and 9
- Rocky Linux 10 and 9
- openSUSE Tumbleweed (rolling), Leap 16.0 and Leap 15.6
- Arch Linux (rolling)
Minimum requirements are 4GB RAM and 20GB disk, on which it takes <15 minutes.
Already existing dotfiles are overridden without prompting. There is no uninstaller currently.
If in doubt, test drive in a virtual machine.
Installer requires only curl available:
curl -fsSL https://raw.githubusercontent.com/raas-dev/configent/1.180.4/install.sh | sh
Things are installed primarily per-user, but to install system-wide requirements
(such as git), sudo password may be asked in the beginning.
The respective git tag from this repository is cloned in ~/configent,
or main branch is pulled on top of the git working copy if it already exists.
User's configs (dotfiles, symlinks and directories) overridden are backed up in
~/configent/.backup with same directory hierarchy as they located in $HOME.
Script install.sh is non-interactive and suitable for cloud-init when run as
user with passwordless sudo.
The defaults are what is most often used in software development in cloud. If you want to deviate from it, the fastest is to fork this repository, make changes and cURL your public fork.
GUI apps are not installed by install.sh as a server is assumed, unless you
explicitly pass FLATPAKS=true (Linux distros) or CASKS=true (macOS) to the
script.
Alternatively, you can run bootstrap in the git working copy (~/configent)
to install GUI apps.
Add or remove GUI apps to your liking in bin/install_apps_flatpak
(Flatpak on Linux distros) or bin/install_apps_cask (Homebrew Cask on macOS).
To use GUI apps on Linux distros, you have to install Xorg, display manager and window manager of your choice. See your distro's own instructions for that.
Script bootstrap essentially handles the whole automated setup (dotfiles,
apps) of the machine it is run in.
The script is non-interactive: Due to this, and though Zsh is preferred, it is
not set as the user's default shell. You may do it and get prompted, possibly
asked sudo, by running bin/setup_zsh after bootstrap has finished.
Symlinks are created in in the user's home directory for all the files in
dotfiles/.
Files or symlinks of the same name at $HOME are overridden without asking,
but they are backed up first in .backup/.
Directory bin in this repository is symlinked to ~/.local/configent/bin
and is first in PATH after you restart the shell or run source ~/.bashrc.
All the scripts in bin/ are available by name from then on. Also now you
can simply reload the configuration of the current shell with r.
💡: Export your own environment variables outside the git repo in ~/.rclocal.
Apt, yum (dnf), zypper, pacman and apk package managers are recognized and used
to install mostly build-time requirements and other absolute necessities
from Linux distro's repository, which requires sudo rights.
Everything (else) that can be installed only user-wide is done so, as following.
Sensible defaults are used, what's installed by default:
- Zsh and antidote (Zsh plugin manager)
- Other command-line essentials and a few build time requirements
- Vim, Vundle (plugin manager for Vim) and Vim bundles (Vim plugins)
- GUI apps by Homebrew Cask (macOS) or Flatpak (Linux distros)
- Rust, Go, Node.js, Python and .NET language runtimes and a few packages
- Linters (static analysis tools) and AWS and Azure development tools
- Neovim with LazyVim
- Tmux, tpm (Tmux Plugin Manager) and tmux plugins
- Ollama and it is (auto-)started on background
Also on both macOS and Linux distros, with a few exceptions (GUI apps, Ollama) everything is installed by mise.
It is strongly recommended to export GITHUB_TOKEN=.
This avoids getting rate limited by GitHub on parallel installation.
💡: Enable or disable tools in etc/mise/config.toml, then run install_mise.
Also see mise for using and locking
project specific versions.
Mise is always preferred over Homebrew.
Use mise backends and plugins to add more tools. Use Homebrew to install absolutely minimum build-time requirements.
On Linux distros Homebrew is installed in /home/linuxbrew.
If sudo is not possible, then it is installed user's home.
Terminess monospace font is installed. The font is used by IDE.
IDE configuration is then symlinked and IDE extensions are installed. The configuration is backed up first if the IDE is already in use.
These steps are detailed further below.
VS Code is the default IDE.
You can change the default by setting environment variable
DEFAULT_IDE="<BIN_NAME>" (e.g. export DEFAULT_IDE="cursor") in ~/.rclocal.
Extensions in Open VSX Registry are available for all VS Code likes and thus are preferred when choosing extensions.
To update vscode/extensions.list in repo after adding or removing extensions
via default IDE, run vscode/create_extensions_list.
The script symlinks vscode/ to <editor_specific_path>/User.
Existing User directory is first backed up to
~/configent/.backup/<editor_specific_path>/User.
bin/install_apps_ for that.
If editor command-line binary is present when running this script,
the extensions (vscode/extensions.list) are installed.
💡: You can reuse vscode/create_extensions_list and setup_code for any
VS Code like editor already installed. See the scripts' arguments for that.
Zsh loads antidote and uses it to install Zsh
plugins (~/.zsh_plugins.txt) on the first start.
Set zsh as the user's default shell:
setup_zsh
If you prefer bash instead:
setup_bash
These scripts are interactive as they prompt to change the default shell,
(unless that is default already). Such change may also require sudo
password to be entered, so if NONINTERACTIVE=true is passed (such as
bootstrap does), the default shell won't be changed. The shell plugins,
if any, are installed even in that case.
Supported container runtimes:
- the original OCI compatible runtime was Docker (used by Docker Desktop)
- containerd is the industry-standard (CNCF) runtime in Kubernetes deployments
- third option is Podman, which is nearly Docker compatible daemonless runtime
These bin/ shims wrap the container CLIs to use those runtimes:
docker: Runs Docker CLI, installs build and compose CLI plugins on first usenerdctl: Runs nerdctl CLI for the rootless containerd installed on the VMpodman: Runs Podman CLI, installs compose CLI plugin on first use
Container runtimes base on Linux kernel features not present on macOS. Thus Lima is used for creating Linux VMs.
The aforementioned shims create and start the necessary virtual machines: Ubuntu for Docker and containerd and Fedora for Podman.
In addition, VM 'debian' has k3s for testing on Kubernetes.
See VM's startup message for exporting KUBECONFIG to use it with kubectl.
The following host directories are mounted read-write for VMs:
$HOME/dev$HOME/Downloads/tmp/lima
Alias d is a shortcut for building Docker image in the current directory.
Dockerfile is read if present, otherwise nixpacks
is used to detect the tech stack and build the image best-effort.
FROM is safe before proceeding.
After the image is built, a new container is launched from it. If .env file
is present in the current directory, its environment variables are set in the
container.
If you use PORT=8000 d, the port given is mapped to the host and environment
variable PORT is set inside the container. Note that this takes precedence
if PORT is also defined in .env file.
If d -d or d --detached is used, all arguments are passed to docker run.
CMD defined in Dockerfile is effective. ENTRYPOINT defined in Dockerfile
(or by nixpacks) is effective, unless you override it in arguments.
If container was started as detached and successfully started up, docker logs
are followed. Sending ^C exits the log view and does not stop the container.
If -d or --detached is not used, an interactive session is assumed and all arguments are passed to docker run entrypoint /bin/sh -c as commands, e.g.
d bash starts Bash in the container. Exiting the shell stops the container.
Nix is not installed on the host, but alias nixd starts
a container where nix, nix-env, nix-shell, etc. are available.
The image is built by etc/nix/Containerfile and is run on containerd.
This enables NixOS like experience without going all-in NixOS (even on a VM).
Use alias n e.g. n vim README.md to open README.md, where Vim is running
in an isolated nix-shell in the container. The volume mount is created based
on the current working directory.
Package name(s, separated by forward slashes) are taken as the first argument.
The binary is assumed named according to the first package. The rest of the
arguments are passed to the binary. If binary name is different from the
package name, put meta-package "shell" first, e.g. n shell/postgresql psql.
The packages are installed from channel unstable.
You can expose PORT for servers, e.g. PORT=8000 n python3 -m http.server.
💡: Use n for command-line tools not wanted permanently installed on the
host. See .aliases for such examples, like ad-hoc security scanners.
Use alias v for managing
Lima VMs for various Linux distros.
VMs are provisioned by cloud-init
on boot by pulling and running install.sh from this repository's main branch.
install.sh
and is only updated by release.sh.
You may willingly run the installer from the latest commit by passing GIT_REF:
curl -fsSL https://raw.githubusercontent.com/raas-dev/configent/main/install.sh | GIT_REF=main sh
See CONTRIBUTING.md for more info on that.