forked from ublue-os/boxkit
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,45 @@ | ||
| # boxkit | ||
| # my-box | ||
|
|
||
| A base image and action for Toolbx and Distrobox. | ||
| Sure, you can use the distro you're used to, but what if ... | ||
| ## About | ||
|
|
||
| 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 | ||
| The purpose of this project is to create a customized CLI (Command-Line | ||
| Interface) environment tailored to my specific requirements. The base is Arch | ||
| Linux and it includes a set of tools, configurations, and enhancements that I | ||
| find useful for my daily command-line tasks. You can find the list of installed | ||
| packages in the [packages](packages) file. | ||
|
|
||
| ## How to use | ||
|
|
||
| ### Create Box | ||
|
|
||
| If you use distrobox: | ||
|
|
||
| distrobox create -i ghcr.io/ublue-os/boxkit -n boxkit | ||
| distrobox enter boxkit | ||
|
|
||
| If you use toolbx: | ||
|
|
||
| toolbox create -i ghcr.io/ublue-os/boxkit -c boxkit | ||
| toolbox enter boxkit | ||
|
|
||
| ### Pull down your config | ||
|
|
||
| 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.html#using-distrobox-as-main-cli) and is the intended experience. | ||
|
|
||
| ## Why? | ||
| ``` | ||
| distrobox create -i ghcr.io/severij/my-box -n my-box | ||
| distrobox enter my-box | ||
| ``` | ||
|
|
||
| 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! | ||
| If you use toolbx: | ||
|
|
||
| [](https://youtu.be/7-FPAWjROos) | ||
| ``` | ||
| toolbox create -i ghcr.io/severij/my-box -c my-box | ||
| toolbox enter my-box | ||
| ``` | ||
|
|
||
| ## Verification | ||
|
|
||
| These images are signed with sisgstore's [cosign](https://docs.sigstore.dev/cosign/overview/). You can verify the signature by downloading the `cosign.pub` key from this repo and running the following command: | ||
|
|
||
| cosign verify --key cosign.pub ghcr.io/ublue-os/boxkit | ||
|
|
||
| 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 | ||
| These images are signed with sisgstore's cosign. You can verify the signature | ||
| by downloading the cosign.pub key from this repo and running the following | ||
| command: | ||
|
|
||
| Of course you can make this however you want, but start with the [Toolbx Community images](https://github.com/toolbx-images/images). | ||
| These are a set of mostly-stock images with packages needed to run as a toolbox/distrobox already installed. | ||
| ``` | ||
| cosign verify --key cosign.pub ghcr.io/ublue-os/boxkit | ||
| ``` | ||
|
|
||
| Try to derive your blingbox from those base images so we can all help maintain them over time, you can't have bling without good stock! | ||
|
|
||
| Tag your image with `boxkit` to share with others! | ||
| ## Disclaimer | ||
|
|
||
| ## [](https://repography.com) / Recent activity [](https://repography.com) | ||
| [](https://github.com/ublue-os/boxkit/commits) | ||
| [](https://github.com/ublue-os/boxkit/issues) | ||
| [](https://github.com/ublue-os/boxkit/pulls) | ||
| [](https://github.com/ublue-os/boxkit/commits) | ||
| [](https://github.com/ublue-os/boxkit/graphs/contributors) | ||
| [](https://github.com/ublue-os/boxkit/commits) | ||
| Please note that the tools, configurations, and settings in this repository are | ||
| tailored to my personal preferences and workflow. They may not suit everyone's | ||
| needs or work seamlessly in every environment. Use them at your own discretion | ||
| and make any necessary modifications to adapt them to your specific | ||
| requirements. This repo itself is a fork of | ||
| [ublue-os/boxkit](https://github.com/ublue-os/boxkit). |