Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README #77

Merged
merged 1 commit into from
Aug 17, 2024
Merged

docs: update README #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 1 addition & 57 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,6 @@ boxkit is a set of GitHub actions and skeleton files to build toolbox and distro

You can use whatever distribution you want with boxkit, this is the initial example ([here are more](https://github.com/ublue-os/toolboxes/tree/main/toolboxes)):

A base image and action for Toolbx and Distrobox.
Sure, you can use the distro you're used to, but what if ...

This image is going to experiment with what a "born from cloud native" UNIX terminal experience would look like.
It is used in conjuction with a [dotfile manager](https://dotfiles.github.io/utilities/) and designed to be the companion terminal experience for cloud-native desktops.
We're starting small but have big aspirations.

- Starts with the latest Alpine image from the [Toolbx Community Images](https://github.com/toolbx-images/images)
- Adds some quality of life
- `starship` prompt for that <3
- `just` for task execution
- `chezmoi` for dotfile management
- `btop` for process management
- `micro` and `helix` text editors
- [clipboard](https://github.com/Slackadays/Clipboard) to cut, copy, and paste anything, anywhere, all from the terminal!
- `python3`
- Some common power tools: `plocate`, `fzf`, `cosign`, `ripgrep`, `github-cli`, and `ffmpeg`
- CLI tools recommended by [rawkode](https://www.youtube.com/watch?v=TNlDSG1iDW8)
- [zellij](https://github.com/zellij-org/zellij) - terminal workspace
- [direnv](https://direnv.net/) - environment variable extension for your shell
- [atuin](https://github.com/ellie/atuin) - magical shell history
- Host Management QoL
- These are meant for occasional one off commands, not complex workflows
- Auto symlink the flatpak, podman, and docker commands
- Auto symlink rpm-ostree for Fedora
- Auto symlink transactional-update for openSUSE MicroOS

## How to use

### Create Box
Expand All @@ -57,32 +30,12 @@ If you use toolbx:

Use `chezmoi` to pull down your dotfiles and set up git sync.


### Make your own

Fork and add programs to this this image - over time you'll end up with the perfect CLI for you.
Keeping it as a pet works, though the author recommends leaving all your config in git and routinely pulling a new image.

The user experience is much nicer if you [set your terminal open right in the container](https://distrobox.privatedns.org/useful_tips/#using-distrobox-as-main-cli) and is the intended experience.

## Why?

While LTS images pay the bills they move at that pace for a reason, I wanted:

- Something that kept up the pace with cloud native tech
- Expansive repos so all stack needs are covered
- But also has all the cool new tools the rustaceans keep cranking out
- apk is _fast_

And of course, as the user space for a cloud-native desktop the biggest reason is it's everywhere in the stack, why not be the "default terminal"?

Also, I've never gotten really to know Alpine, the problem with running distros like this bare metal on my PC is that there's a whole bunch of hardware quirks and all sorts of little enablement things that more generalized distros tend to get right.

But in a Toolbx/Distrobox world the kernel and anything that talks to hardware is handled by the host operating system.
This let's us concentrate on just the CLI experience, get yourself some of that UNIX bling.
Also apk is fast. Watch the video for more!

[![Video Recording](https://img.youtube.com/vi/7-FPAWjROos/0.jpg)](https://youtu.be/7-FPAWjROos)
The user experience is much nicer if you [set use Ptyxis](https://flathub.org/apps/app.devsuite.Ptyxis) and is the intended experience.

## Verification

Expand All @@ -92,15 +45,6 @@ These images are signed with sisgstore's [cosign](https://docs.sigstore.dev/cosi

If you're forking this repo you should [read the docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets) on keeping secrets in github. You need to [generate a new keypair](https://docs.sigstore.dev/cosign/overview/) with cosign. The public key can be in your public repo (your users need it to check the signatures), and you can paste the private key in Settings -> Secrets -> Actions.

## Scope and Cynicism

I know what you're thinking, we're just going to shove everything from [Modern UNIX](https://github.com/ibraheemdev/modern-unix) in there and it's going to look like a glitter explosion.

That's why I'm going to be strongly opinionated, so use this as a base to build your own perfect CLI experience.
Custom configs are NOT included, those belong in your dotfiles, use them in combination with an image.

This is a tame first effort, one of you out there is going to make something better than this, the perfect CLI workspace, I salute you.

## Finding Good Base Images

Of course you can make this however you want, but start with the [Toolbx Community images](https://github.com/toolbx-images/images).
Expand Down