Repository navigation
Naming
The project is named peppol-cli, the executable is peppol.
| Item | Value |
|---|---|
| Project / repository name | peppol-cli |
| Executable / command name | peppol |
| Maven groupId |
com.helger.peppol > TODO(verify): confirm against the groupId already used for the sibling Peppol projects
|
| Java base package |
com.helger.peppol.cli > TODO(verify): confirm
|
Rationale: the repository name says exactly what the artefact is, and the executable name is what a user
would type first when guessing. Every command reads as a sentence — peppol smp lookup, peppol pid validate,
peppol cert verify. A ph-prefixed pun would be recognisable inside the phax ecosystem but meaningless
to the AP and SMP operators who are the primary audience.
| Name | Why rejected |
|---|---|
phrobe |
Pun-first; gives the reader no clue that this is about Peppol. |
phetch |
Same problem, and it suggests a download tool rather than a diagnostics tool. |
phinder |
Same problem; also easy to misspell and collides conceptually with generic "finder" tools. |
phlox |
No connection to the domain at all (it is a flower). |
phoss-cli |
phoss is the product-family prefix for the server products (phoss SMP, phoss AP). This tool is not a phoss server product, and it is not limited to administering them. |
peppolctl |
The -ctl suffix implies a control plane for one's own deployment (as in kubectl, systemctl). Most of this tool is read-only lookup and diagnostics against the public network. |
These do not affect the decision above; they are due diligence to be done before the first public release.
-
Trademark courtesy check. "Peppol" is an OpenPeppol trademark. Ask OpenPeppol whether they are content
with the project name and the executable name, and make the disclaimer prominent in the README and on
Home — this is not an official OpenPeppol tool.
> TODO(verify): the correct OpenPeppol contact point and whether a written trademark-usage guideline exists -
Collision checks. Confirm the name is free on:
- GitHub (organisation and repository name)
- Homebrew (formula and cask name)
- npm and PyPI (to keep a future wrapper package possible)
- Debian/Ubuntu, Fedora and Arch/AUR package names
- the
peppolbinary name against anything already on a typical$PATH
peppol-cli — licensed under the Apache License, Version 2.0.
Not an official OpenPeppol tool. This is an independent open source project and is neither endorsed by nor affiliated with OpenPeppol AISBL. "Peppol" is a trademark of OpenPeppol AISBL.
Status: planning
Overview
Design
Decisions
Reference