CLI Overview

The official CLI binary for Lioran S3 is liorans3, packaged as @liorans3/cli.

npm install -g @liorans3/cli@prealpha

---

Global Options

The following flags can be passed to any liorans3 command:

-v, --version               Output the current version of liorans3
-p, --profile <name>        Select named configuration profile
-e, --endpoint <uri>        Server connection URI (e.g. bastion://user:pass@host:port)
-u, --username <username>   Basic authentication username
-P, --password <password>   Basic authentication password
-k, --access-key <key>      Programmatic Access Key ID
-s, --secret-key <secret>   Programmatic Access Key Secret
--json                      Output results in machine-readable JSON format
-q, --quiet                 Suppress non-essential progress and informational messages
--no-color                  Disable colored terminal output
-t, --timeout <ms>          Request timeout in milliseconds
-h, --help                  Display help for command

---

Exit Codes

The CLI emits standard, deterministic exit codes suitable for automation, scripts, and CI/CD pipelines:

Exit Code	Constant	Meaning
0	EXIT_SUCCESS	Operation completed successfully.
1	EXIT_ERROR	General or unhandled application error.
2	EXIT_USAGE	Invalid command-line usage or malformed arguments.
3	EXIT_AUTH	Authentication error or invalid credentials.
4	EXIT_FORBIDDEN	Permission denied or password change required.
5	EXIT_NOT_FOUND	Target bucket, object, user, key, or upload session not found.
6	EXIT_NETWORK	Network failure, connection refused, DNS error, or timeout.
7	EXIT_CONFLICT	Resource conflict (e.g. bucket or user already exists).
8	EXIT_CAPACITY	Bucket quota exceeded or host storage capacity exhausted.

---

Command Groups

Command Group	Description	Primary Subcommands
bucket	Manage storage buckets	list (ls), create (mb), info (get), update, rm (delete, rb)
object	Object operations	list (ls), stat (head), put, get, cat, range, presign, rm (delete), optimize
multipart	Resumable chunked uploads	upload, create, status, part, complete, abort, resume
user	User account management	list (ls), get (info), create, update, enable, disable, rm, passwd, reset-password
key	Access key management	list (ls), get (info), create, rotate, revoke (rm)
profile	Named configuration profiles	list, show (get), create, use, rename, delete (remove)
configure	Interactive configuration	Setup server endpoint and credentials
diagnostics	Health and diagnostics	doctor, ping, whoami, system health, system info, system performance, system metrics

---

Machine-Readable JSON Output

Every CLI command supports the --json flag, printing structured JSON payloads directly to stdout without decorative tables or logs:

liorans3 bucket ls --json

[
  {
    "name": "assets",
    "owner": "admin",
    "quota_bytes": 53687091200,
    "versioning_enabled": false,
    "created_at": "2026-10-01T12:00:00.000Z"
  }
]