CLI
calternal command line client. This reference is generated from the command tree in crates/calternal-cli (through contracts/cli.json). For a guided tour, read the CLI walkthrough.
calternal [--json] [--server <SERVER>] [--timeout <TIMEOUT>] [--retries <RETRIES>] [--confirm] <COMMAND>Global options
Section titled “Global options”| Argument | Description | Default |
|---|---|---|
--json |
false |
|
--server <SERVER> |
||
--timeout <TIMEOUT> |
Timeout per HTTP request in seconds | 120 |
--retries <RETRIES> |
Maximum retries for transient failures | 3 |
--confirm |
Confirm a change that the write rule protects (see –help). One global flag keeps non-interactive use with a scoped credential simple (#838) | false |
Commands
Section titled “Commands”| Command | Summary |
|---|---|
action |
Inspect or invoke operations from the shared API registry (#484) |
login |
Approve this installation in a signed-in browser |
completions |
Print a shell completion script built from the command and registry tree (#838) |
sync |
|
ls |
|
files |
User-level Files visibility preferences exposed by the server |
cat |
|
put |
|
get |
|
mv |
|
rm |
|
trash |
|
restore |
|
versions |
|
search |
|
mail |
Mail reader operations use stable provider-backed IDs and delegate all writes to the server (#396, DESIGN §45) |
tasks |
|
task |
|
duplicate |
|
journal |
Add existing Home files to stable Journal entries through the server API (#421) |
calendar |
Calendar feed and URL subscription commands use the same Calendar API as the web app |
share |
|
today |
|
note |
|
money |
Preview, confirm or cancel a Money import token (#462) |
log |
|
logout |
|
whoami |
Exit codes and output
Section titled “Exit codes and output”Exit codes: 0 success; 1 local or other failure; 2 usage error; 3 not logged in; 4 not found; 5 conflict; 6 permission or scope denied; 7 quota exceeded; 8 rate limited; 9 network or transient failure; 10 server error. Success JSON has schema version 1 and wraps the result in data. Error JSON has schema version 1 and includes error.message and error.exit_code. Writes: registry actions (action run and action <area> <verb>) need –confirm for every change and accept –dry-run to print the request first; named commands run recoverable changes (Trash, move, reopen, share) without –confirm and need –confirm to remove data or links permanently. –timeout sets the per-request timeout in seconds (default 120, range 1 to 3600). –retries sets the maximum retry count (default 3, range 0 to 5).