Post command-line reference.
A complete reference for Post commands and options. For a quick reminder at any time, run post -h or post -help from your terminal.
Quick help
Post includes built-in help, so you do not need to return to this page just to remember a command.
Both options display the Post command summary, transfer commands, identity commands, account commands, configuration commands, send options, global options, and examples.
Command format
Most work is performed with a command such as send, list, or find. Global options such as -help and -version can be used directly with Post.
Transfer commands
These commands send and retrieve encrypted messages and files.
| Command | Description |
|---|---|
post send <name> | Send one or more files, a message, or both to a Post name. Use the send options below to specify the content, sender, and retention period. |
post list | List transfers currently waiting for you. |
post get [id] | Retrieve a specific waiting transfer by transfer ID. If the ID is omitted, Post retrieves all waiting transfers. |
Send options
Send options are used with post send <name>. A transfer can contain a message, files, or both.
| Option | Description |
|---|---|
-f <file>-file <file> | Add a file to the transfer. This option may be repeated when sending multiple files. |
-m <message>-message <message> | Add a text message to the transfer. Quote messages that contain spaces. |
-s <name>-sender <name> | Override your default Post name for this transfer and send using another local Post name. |
-ttl <days> | Set how long the transfer is retained. Valid values are 1 through 30 days. The default is 15 days. |
Examples
Identity commands
Post names identify senders and recipients. Before sending to someone for the first time, exchange Post names through your normal trusted communication and use post find to confirm that the name is registered.
| Command | Description |
|---|---|
post init <name> | Create and register a Post name. For a new Free user, this establishes the local Post identity used to begin using the service. |
post names | List the Post names available locally. |
post names default <name> | Set which local Post name is used as the default sender. |
post find <name> | Look up a Post name and confirm that it is registered. Registration alone does not prove who owns the name, so confirm unfamiliar recipients through a trusted communication channel. |
Account commands
Account commands manage the account information stored by the Post client and provide access to plan, usage, renewal, and upgrade information.
| Command | Description |
|---|---|
post account import | Import an annual account key into the Post client, such as when activating or updating a paid account. |
post account status | Show the current account, plan, and usage information. |
post account renew | Show account renewal information. |
post account upgrade | Show available Post plans and pricing information. |
post account remove | Remove the account credentials stored locally by the Post client. |
Configuration commands
Configuration commands let you inspect the active Post configuration and change supported settings without manually editing the configuration file.
| Command | Description |
|---|---|
post config show | Display the current Post configuration. |
post config path | Display the location of the Post configuration file. |
post config set <key> <value> | Change a supported configuration setting by supplying its key and new value. |
Global options
These options provide information about Post itself and can be used without performing a transfer.
| Option | Description |
|---|---|
-h-help | Display the built-in Post command-line help and quick reference. |
-v-version | Display the installed Post version. |
-buy-more | Display the available Post plans, limits, pricing, and the website address for purchasing or upgrading. |
Quick reference
New to Post?
The command reference is designed for looking things up. If you have not sent a transfer yet, the Getting Started guide walks through the process from creating your Post name through confirming a recipient and receiving a transfer.
Getting Started