Install dot files and packages, including a base mode with sensible defaults to run on most computers running Debian based distros or macOS.
Project description
💻 onboardme
Get your daily driver just the way you like it, from textformatting, and dot files to opensource package installation, onboardme intends to save you time with initializing or upgrading your environment.
Features
- manage your dot files using a git repo (or use our default dot files 😃)
- install and upgrade libraries and apps
- supports different several package managers and a couple of operating systems
- can group together packages for different kinds of setups, e.g. gaming, devops, gui
- easy
yaml
config files in your$HOME/.config/onboardme/
directory
Screenshots
Example of the terminal after onboardme
runs
Quick Start
Installation
The quickest way to get started on a fresh macOS or distrubtion 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)"
# this will display the help text for the onboardme cli
onboardme --help
You can also read more in depth Getting Started Docs 💙!
There's also more documentation on basically every program that onboardme touches.
Upgrades
If you're on python 3.11, you should be able to do:
pip3.11 install --upgrade onboardme
Configuration
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 ~/.config/onboardme/
(will use $XDG_CONFIG_HOME
, if defined). Examples below:
config.yaml
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:
- dot_files
- packages
- font_setup
- vim_setup
- neovim_setup
- sudo_setup
# these are linux specific steps
Linux:
- dot_files
- packages
- font_setup
- vim_setup
- neovim_setup
- 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
# - gaming
# - devops
Under the Hood
Made for the following OS (lastest stable):
Optimized for:
Built using these great projects:
Status
Still not production ready, but reasonably stable :)
Please report 🐛 in the GitHub issues, and we will collect them, and release them into the wild, because we are vegan and nice. (Kidding, we will help! 😌)
We love contributors! Feel free to open a pull request, and we will review it asap! :)
:star: If you like this project, please star it to help us keep motivated :3
Contributors
JesseBot |
Max! |
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 locally, even on metal with smol k8s lab.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for onboardme-0.16.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f213b2196ead752a53e187c8c56a727c82b3f37746de206bce158f078809f44e |
|
MD5 | a64e309334e35183fc905b6ca05f4d3c |
|
BLAKE2b-256 | a7020c51e90770996f281b94683f70d78009b12252d81bff3090e89bf0995267 |