The app on the command line
Type a short command in a terminal and the LibrePortal app on your computer does it, using the logins it already holds. Look at your servers, fix DNS, move a domain, price a bigger server.
The LibrePortal app on your computer can also be driven from a terminal. You type a short command, the app that is already open does the work, and the answer comes back as plain text. It is the same app, the same unlocked vault and the same linked companies, so there is nothing new to set up and no key to copy anywhere.
It is handy when you want a quick look without clicking, when you want to run the same thing again and again, or when another tool on your computer needs an answer from the app.
The app has to be open
Commands go to the LibrePortal app that is open on this computer. If it is closed, the command says Open LibrePortal first. If your vault is locked, it says Unlock LibrePortal on this computer first. Type libreportal-app unlock and the app brings its unlock box to the front.
Why it asks you in the app
Anything that spends money, or switches where a domain's name servers point, always waits for your yes in the app window. The command shows you the price and brings the window to the front. It cannot press the button for you. That keeps a stray script from ever buying something.
Getting it#
The Linux app installs a libreportal-app command next to it. Open a terminal and type:
libreportal-app help
That lists every command, grouped. Add --help to any command for its own page, for example libreportal-app resize --help. Add --json to any command to get the answer as JSON, for a script to read. No answer ever contains a key, token or password.
When a command works it ends quietly with the usual success. If it does not, the reason is printed, and the exit code tells a script why:
| Code | Means |
|---|---|
| 0 | It worked. |
| 1 | It could not do it. The reason is printed. |
| 2 | The command was typed wrongly. |
| 3 | The app is not open. |
| 4 | The vault is locked. |
| 5 | Waiting for your yes in the app window. |
Looking#
These only read. They change nothing.
Your servers.
libreportal-app servers
Name Address State Company Plan
Home box 203.0.113.11 Online OVH VPS-1
Mail box 203.0.113.9 Online - -
What still needs you on one server. It is the Setup list from the app.
libreportal-app server "Home box" status
Home box: 2 things need you.
Safer logins: Anyone can still try passwords on this server [Turn off passwords]
Web address: example.org needs 2 records [Fix records]
Your domains.
libreportal-app domains
Domain Server DNS company Login To improve
example.org Mail box deSEC Linked 2
What a domain wants, and what is found.
libreportal-app domain example.org records
Type Name Wanted Found State
A example.org 203.0.113.9 203.0.113.9 Done
A *.example.org 203.0.113.9 - To do
CAA example.org 0 issue "letsencrypt.org" - To do
The companies you linked.
libreportal-app providers
Company State Note
deSEC Working Connected
OVH Working Key valid until 2027-05-01
Changing#
Fix a domain's records. This is the same as the automatic fix on the domain's page. It adds what is missing and puts back what LibrePortal made and something changed. Records you set another way are left alone, and a backup is kept first. It prints what it changed.
libreportal-app domain example.org fix
Changed in example.org:
A *.example.org 203.0.113.9 (added)
CAA example.org 0 issue "letsencrypt.org" (added)
A backup of the old records was kept.
The company that answers the domain's DNS has to be linked in the app. If it is not, the command says so and tells you where to link it.
Move a domain's DNS to another company. The company must already be linked.
libreportal-app dns move example.org --to deSEC
The old records are copied across first, so mail and websites keep working. The last step is switching the name servers at the registrar. If the app can do that itself, it waits for your yes in its window. If not, the command lists the name servers for you to set by hand.
Change the size of a rented server. Only for companies that allow it from the app (OVH today), and only to a bigger plan.
libreportal-app resize "Home box" --plan VPS-2
Home box: VPS-1 -> VPS-2 (2 vCPU · 4 GB · 80 GB)
Charged now (VAT included): £4.20
Then each month: 9.00 GBP
Nothing is bought yet. Confirm in the LibrePortal window to change size.
The app window comes forward with its usual confirm box. The command stops there, with code 5. Add --price-only to just see the price and leave the window alone. If the company refuses, for example because the plan is out of stock, you get its reason and nothing is ordered.
Opening#
Open a server's console at its hosting company:
libreportal-app console "Home box"
Bring up the unlock box in the app:
libreportal-app unlock
Names
A server name needs only the beginning if that is enough to tell it apart: server home status finds Home box. Put names with spaces in quotes.
How it stays private#
The command does not hold your logins. The open app listens only on your own computer, and only for programs that can read a small secret file in your own account folder, which nobody else on the computer can read. A program running as someone else on the same computer can knock, but without the secret it is turned away and nothing runs. The command line is for the Linux app; the Windows app has no libreportal-app command yet.