Skip to main content

An onboarding tool to install dot files and packages including a default mode with sensible defaults to run on most Debian/macOS machines.

Project description

☁️ onboardme 💻

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

This is a project to store config files, as well as programatically install core packages across several package managers that we need for development. A lot of this was amassed from many years of quickly looking into a thing™️ , jotting it down, and then just hoping we'd remember why it was there later, so this is now a renewed effort in remembering all the thing™️s, and automating as much as possible. The idea is that it's faster, smaller, and easier to configure than it's ansible equivalent.

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

screenshot of terminal after runnign 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 Debian OS 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 for the onboardme cli
onboardme --help

You can also read more in depth Getting Started docs 💙!

More Docs

We've recently setup a justthedocs page here.

Upgrading

If you're on python3.11.0 or later, 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

And built using these great projects. Please go check them out:

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

Collaborators

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.

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.7.tar.gz (41.1 kB view hashes)

Uploaded Source

Built Distribution

onboardme-0.15.7-py3-none-any.whl (45.7 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