Skip to main content

An onboarding tool to install dot files and packages including a default 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
  • 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

./docs/onboardme/screenshots/help_text.svg alt='screenshot of full output of onboardme --help

Here's an example of the terminal after the script has run:

screenshot of terminal after running onboardme. includes colortest-256, powerline prompt, icons for files in ls output, and syntax highlighting examples with cat command.

Quick Start

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.

Upgrading

If you're on python 3.11, you should be able to do:

pip3.11 install --upgrade onboardme

Features

Made for the following OS (lastest stable):

made-for-macOS made-for-debian made-for-ubuntu

Optimized for:

made-with-for-vim made-with-python made-with-bash

Built using these great projects:

rich python library logo with with yellow snake nerd-fonts: Iconic font aggregator, collection, and patcher

Status

🎉 Active project! Currently in later alpha :D (But not yet stable. There be 🐛.)

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
JesseBot
cloudymax
Max!

Shameless plugs for other projects

Looking for a project to get running on a machine that has no OS at all? Check out pxeless.

Actually looking to get started with virtual machines and QEMU? Check out scrap metal.

Looking for a project to get started with self hosting k8s stuff? Check out 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

onboardme-0.15.14a2.tar.gz (42.9 kB view hashes)

Uploaded Source

Built Distribution

onboardme-0.15.14a2-py3-none-any.whl (46.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page