Install dot files and packages, including a base mode with sensible defaults to run on most computers running Debian based distros or macOS.
Get your daily driver, or personalized 🐳 container, just the way you like it! From dot files management, to package installation, to setting up neovim, to other little features you didn't know you needed,
onboardme intends to save you time with initializing and maintaining your personal evironments ✨
Keep your Dot Files Up To Date Across multiple systems
onboardme can manage your dot files using a git by turning your home directory into a repo.
We even provide default dot files, so you don't have to manage them
- The default dot files are open source, and the maintainers use these themselves
- They cover a lot of common apps/tools you probably want anyway
- They have consistent colorschemes accross different CLI/TUI programs 😃
- They set all the helpful BASH aliases you could need (zsh support coming soon)
Package management accross multiple package managers
We install and upgrade libraries and apps using common package managers. We also provide a currated list of default packages.
- checkout the default packages
pip(and you can add your own 😄)
- group together packages for different kinds of environments
- onboardme provides default package groups:
- default (no desktop GUI apps installed by default, always installed)
- macOS (default apps for macOS only apps, always installed on macOS)
- gui (default GUI apps for Linux desktops, optionally installed)
- devops (devops related tooling, optionally installed)
- onboardme provides default package groups:
Linux ARM Users NOTE:
brew is currently unsupported on linux/arm64, and as we'd have to compile everything from source anyway, we don't support running the brew package manager via onboardme on linux/arm64 or (AArch64) at all right now._
We do have a docker image (jessebot/onboardme:latest-arm) optimized for arm though that you can run on AArch64 and it's perfect for a dockerized dev environment on an M1 or later mac or any other ARM 64 device that runs docker :)
NeoVim Plugin Installtion and Updates
onboardme keeps your neovim plugins installed and up to date with lazy.nvim under the hood.
Why no vim though?
If you haven't already made the switch from Vim to NeoVim, you can try out NeoVim today with
onboardme :D We used to support both neovim and vim, but these days none of the primary developers of this repo use pure vim anymore, so we can't ensure it's up to standards. All of your knowledge from vim is still helpful in neovim though, and we highly recommend switching as neovim has a lot more features and a very active plugin community :) NeoVim maintains a guide on how to switch from vim here.
yaml config files using XDG Base Directory Spec
yamlconfig files using XDG Base Directory Spec
We use use XDG Base Directory Spec for config files so you always know where they are :)
Docker image for an on-the-go dev workspace
The docker image is built nightly, and on push to
main via GHA. The base image is
debian:bookworm, but we will rollout support for Ubuntu down the line :)
See the dockerhub page for more info!
Other optional configurations
- Enable touchID for sudo on macOS
- Add your user to the docker group
- Install nerdfonts (defaults to mononoki and Symbols Only)
Examples of the terminal after
Powerline and ls
Powerline with git
Image and colors
Python virtual env in powerline and cat
git, and Python 3.11 to get started. We have a setup script to install those (except
curl) and help you get your environment to the XDG spec under Locally. For docker, see the section below.
Local prereq install script.
curl, a pre-prereq
# Debian/Ubuntu may not have curl installed depending on where you are, so this will install it for you type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
Make sure you have sudo access, otherwise we won't be able to install certain things. The quickest way to get started on a fresh macOS or distro of Debian (including Ubuntu) is:
# this will download setup.sh to your current directory and run it /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/jessebot/onboardme/main/setup.sh)"
Source your updated
# for linux source ~/.bashrc
source your updated
bash source ~/.bash_profile
You will still have to set your default shell to BASH to if you want to take advantage of the default dot files for onboardme. You can do that like this:
brew install bash sudo -i # if you're on an M1 or newer: echo "/opt/homebrew/bin/bash" >> /etc/shells && exit chsh -s /opt/homebrew/bin/bash $(whoami) # if you're on a mac earlier than the M1: echo "/usr/local/bin/bash" >> /etc/shells && exit chsh -s /usr/local/bin/bash $(whoami)
After that, you can also set the shell directly in your terminal app via the settings.
If you've already got all the above prereq on your machine, you can just do:
# should also work with pipx, if you'd like to use that instead pip install --user --upgrade onboardme
Using the Docker image
Read more about our docker tags and how to use them at jessebot/onboardme on DockerHub.
Now you can run
# this will display the help text for onboardme onboardme --help # Running this won't overwrite any existing dot files, but it may add new ones. onboardme
From here, if you want to completely wipe your existing dot files for a fresh start with with
onboardme, you can run:
# WARNING: This will overwrite your local dotfiles, including your .bashrc and .bash_profile # can also be done with: onboardme -O onboardme --overwrite
You can read more in depth at the Getting Started Docs 💙! There's also more docs on basically every program that onboardme touches.
If you're on python 3.11, you should be able to do:
pip3.11 install --upgrade onboardme
onboardme has lots of CLI options, but you can also use config files. You have to create these files for the time being.
Config files are in
$XDG_CONFIG_HOME is not defined.
||For step configuration to run either all steps, or just a subset.|
||For adding packages with different package managers|
log: # Full path to a file you'd like to log to. Creates file if it doesn't exist file: "" # what level of logs to output (DEBUG, INFO, WARN, ERROR) level: "INFO" # steps refer to a specific function in the list of functions we run steps: # these are mac specific steps Darwin: # clones dot files into home dir/git fetches updates for dot files - dot_files # install packages - packages # adds nerdfonts - font_setup # runs :Lazy sync to install all your plugins - neovim_setup # sets up touchID for sudo - sudo_setup # these are linux specific steps Linux: - dot_files - packages - font_setup - neovim_setup # add your user to the docker group - group_setup dot_files: # personal git repo URL for your dot files, defaults to jessebot/dot_files git_url: "https://github.com/jessebot/dot_files.git" # the branch to use for the git repo above, defaults to main git_branch: "main" # !CAREFUL: runs a `git reset --hard`, which will overwite/delete local files in ~ that # conflict with the above defined git repo url and branch. You should run # `onboardme -s dot_files` to get the files that would be overwritten overwrite: false # basic package config package: # Remove any of the below pkg managers to only run the remaining pkg managers managers: # these are macOS specific steps Darwin: - brew - pip3.11 # these are linux specific steps Linux: - brew - pip3.11 - apt - snap - flatpak # list of extra existing packages groups to install groups: - default # uncomment these to add them as default installed package groups # - gui # - gaming # - devops
Under the Hood
Made and tested for these operating systems:
And optomized for the following programs:
Built using these great tools:
Actively used by the maintainers daily, but software is always changing, so please report 🐛 in the GitHub issues, and we will collect them, and release them back into the wild, because we are vegan and nice. (Kidding, we will help! 😌)
:star: If you like this project, please star it to help us keep motivated :3
We love contributors! Feel free to open a pull request, and we will review it asap! :)
Shameless plugs for other projects
Get running on a machine using a bootable USB stick with pxeless.
Get started with virtual machines and QEMU with scrap metal.
Get started with testing kubernetes on metal with smol k8s lab.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for onboardme-1.4.0-py3-none-any.whl