15
How to efficiently package CLI application on linux (lemmy.world)
submitted 6 months ago by Lorgres@lemmy.world to c/learn_programming@programming.dev
12 comments fedilink hide all child comments

Hi, I'm looking to open-source a small CLI application I wrote and I'm struggling with how to provide the built app since just providing the binary will not work. I had a friend test it and he had to compile from source due to glibc version differences.

My first thought was providing it as a flatpak but that isn't really suitable for CLI software.

I've googled around a bit and most guides I find just mention packaging separately for multiple package managers/formats (rpm, apt etc.). This seems really inefficient/hard to maintain. What is the industry standard for packaging a Linux software for multi-distro use?

all 13 comments
sorted by: hot top controversial new old
[-] fourwd@programming.dev 7 points 6 months ago

Just build the app on very old distros like Ubuntu 16.04 if possible. But in general, packaging should be handled by the maintainer. If you want to be both a developer and maintainer, packaging problems will take up 75% of your time.

It's not really hard for us users to follow your README and just copy the built binary to ~/.local/bin.

[-] Lorgres@lemmy.world 2 points 6 months ago

Hi thanks for the reply. Could you elaborate on why building for an old distro may be benefitial/a good solution? Thanks for mentioning this developer/maintainer dynamic. It's not a concept I was aware of.

Do you have any projects with good READMEs you could point me to, so I can get an idea of what's important to address?

[-] fourwd@programming.dev 1 points 6 months ago

If you build your app with glibc 2.32 and then run it with glibc 2.39, it will run fine. But it won't work the other way around.

There is no best README template, but for my personal projects I use this:

  1. Title
  • Brief description of the project
  • Features
  1. Build
  • List of supported OS
  • List of dependencies (what packages do I need to build your application)
  • Commands to build the application (what do I need to do to build your application)
  • Binary Locations (where can I find the built binary)
  1. Usage
  • Program arguments (what do I need to provide to use your CLI application)

You can find an example here. I'm not saying this is the best README, but I think it's simple and informative.

[-] Kangie@lemmy.srcfiles.zip 6 points 6 months ago

You don't have to!

If a downstream distribution wants your software they will build and package it themselves and maintain that infrastructure.

You could provide an example rpm spec (etc) to make their lives easier but it's not on you to provide a binary package that works everywhere; you released the source code so any given user / distro can compile it for themselves.

Just make sure that your build infrastructure and docs are up to speed, and ideally implement some CI/CD and testing to catch any breaking changes.

[-] Lorgres@lemmy.world 2 points 6 months ago

I see, thanks for the info. I wasn't even aware that this developer/maintainer dynamic exists. It makes a lot of sense though. I'll start by creating some documentation about building the software and then maybe create an example package for rpm.

[-] superterran@discuss.online 2 points 6 months ago

This dynamic does exist, but you have to build something useful to the likes of Debian and Redhat and that’s a tall order. You should look into Linux brew, it’s a community maintained package management system that might be more suitable for your scale https://docs.brew.sh/Homebrew-on-Linux

[-] FizzyOrange@programming.dev 1 points 6 months ago* (last edited 6 months ago)

This only applies if your program becomes popular or you go to a huge amount of effort packaging it yourself. And even then updates are going to be a huge pain. Do you want your users to be able to use the latest version easily?

There's quite a big gap between "no users" and "included in all distros" where this advice doesn't apply.

[-] Vilian@lemmy.ca 2 points 6 months ago

the best possible "industry standard" in my opinion is nix, but people need to install it on their machine, other than that don't package lol, put a curl link in your github/gitlab to how install it and problem solved lol

[-] CameronDev@programming.dev 1 points 6 months ago* (last edited 6 months ago)

I have seen some CLI tools distributed via docker. You build a docker image and push to dockerhub, then supply a commandline like:

docker run -it -v workdir:workdir myapp:latest myapp [my app args]

~~I cant think of an IRL example for this, but I have seen it a few times.~~

My own example: https://github.com/cameroncros/idevicerestore/tree/docker-container?tab=readme-ov-file#docker

[-] FizzyOrange@programming.dev 0 points 6 months ago

Statically link it with Musl instead. Then you don't have do deal with bullshit glibc issues.

For distribution I package my Rust programs as Pip packages using Maturin. Theoretically you can do the same with any language but I've only tried Rust.

Why on earth would I publish pure Rust programs on PyPI you ask? I stole the idea from CMake, which is distributed there too despite being completely C++. The main advantage is that your users probably already have Pip installed no matter what distro they are using. Maybe even on Mac too. And installation is a single command. No fannying around adding custom repos and keys, making 5 different kinds of packages, etc.

[-] Godort@lemm.ee 0 points 6 months ago

Flatpak seems to be the way most people are doing it now.

Prior to that, it was mostly just packaging an npm and/or deb file and telling anyone not on a redhat/debian system to build it themselves.

[-] lemmyng@lemmy.ca 3 points 6 months ago

Flatpak is for GUI applications. For CLI tooling the distro package managers are still the way to go.

this post was submitted on 10 Apr 2024
15 points (100.0% liked)

Learn Programming

1625 readers
1 users here now

Posting Etiquette

  1. Ask the main part of your question in the title. This should be concise but informative.

  2. Provide everything up front. Don't make people fish for more details in the comments. Provide background information and examples.

  3. Be present for follow up questions. Don't ask for help and run away. Stick around to answer questions and provide more details.

  4. Ask about the problem you're trying to solve. Don't focus too much on debugging your exact solution, as you may be going down the wrong path. Include as much information as you can about what you ultimately are trying to achieve. See more on this here: https://xyproblem.info/

Icon base by Delapouite under CC BY 3.0 with modifications to add a gradient

founded 1 year ago
MODERATORS
Ategon@programming.dev
JaumeI@programming.dev
bugsmith@programming.dev