Skip to main content

Command reference

CommandWhat it doesExit codes
pseudonym whois <alias>Who an alias is: name, alias and linked ones, services, first and last seen0, 2 unknown alias
pseudonym alias "<name>"Everyone whose name contains it (case and accent insensitive), with their aliases and services0, 2 nobody
pseudonym aliases [--service <service>]A service's people as CSV (alias,name) on stdout, a warning on stderr0
pseudonym services [--json]The services in the directory and how many people each has0
pseudonym redact [--service <service>] [--countries ES,US,…] [file]The text (file or stdin) with the service's people as aliases and contact data as placeholders (cards, IBANs, and ids and phones of the countries asked for, Spain by default); counts on stderr0, 1 several services and none chosen, unknown country, unreadable file
pseudonym reveal [--with-alias] [file]The text (file or stdin) with every known alias replaced by the person's name0, 1 unreadable file
pseudonym remember --name <name> [--email …] [--institutional-id …] [--service-user-id …]A person's alias (also --service, --link, --json)0, 1 no name or no identifier
pseudonym remember --csv <file> [--only-aliases]Aliases for a whole CSV, as a CSV with an alias column first (--only-aliases drops names and identifiers); also --json0, 1 a row without name or identifier
pseudonym resolve <alias> [--service <service>]The service user id behind an alias (also --json)0, 2 unknown alias or no id in that service
pseudonym link <alias> <alias>The same person: keep the first alias, the second resolves to it0, 2 unknown alias
pseudonym forget <alias>Remove a person from the directory0, 2 unknown alias
pseudonym forget --service <service> [--yes]Remove the people met only in that service; others lose its id. Asks to confirm0, 1 not confirmed, 2 unknown service
pseudonym forget --all [--yes]Empty the directory, keeping the key. Asks to confirm0, 1 not confirmed
pseudonym prune --older-than <n>(d|m|y)Remove people not seen for that long0, 1 bad age
pseudonym key fingerprintA short code of the key0, 2 no key yet
pseudonym key exportThe key as base64 on stdout, a warning on stderr0, 2 no key yet
pseudonym key importRead a key from stdin (hidden on a terminal)0, 1 different key or not a key
pseudonym key import --forceReplace a different key, keeping the current directory as a .bak0, 1 not a key
pseudonym helpThe list of commands0

All commands exit with 1 on an error, with a message on stderr that says what to do: a missing or damaged key, a directory that can't be read, a missing argument, an unknown command.

Environment​

VariableEffect
PSEUDONYM_HOMEThe folder for the key and the directory, instead of %APPDATA%\pseudonym\ or ~/.config/pseudonym/
PSEUDONYM_SERVICEThe service for commands that take one when --service isn't given, instead of default

Files in the folder​

FileWhat it is
keyThe key: 32 random bytes
usedAn empty marker: a key existed here, so a missing one is a loss, not a first run
directory.encThe directory, encrypted
directory.lockPresent only while a program is changing the directory
directory.enc.<date>.bakThe previous directory, after key import --force

See How it works for what's inside them.