olares-settings

settings (Olares Settings UI mirror)

CRITICAL — before doing anything, load the olares-shared skill first (profile selection, login, token refresh, auth-error recovery). Flag reference: olares-cli settings --help.

Source of truth for flags is always olares-cli settings <area> <verb> --help. This file only carries what --help cannot give: routing, the 13-section index, the role-caching / admin-vs-normal floor, the wire-format cheat sheet, and the common-errors table.

Platform model: the Olares version/semver scheme behind settings me version is defined once in ../olares-shared/references/olares-platform.md.

When to use

• Olares Settings UI (https://docs.olares.com/manual/olares/settings/), olares-cli settings, role (owner / admin / normal), who am I on this Olares instance
• Areas: users, appearance, apps (entrances / env / domain / policy), integration (awss3 / tencent), VPN (devices / ACL / SSH), network, GPU, video, search, backup / restore, advanced (containerd registries, env)
• Mutating: language set, search rebuild, integration add/delete, VPN SSH / ACL, users create/delete

Anything outside this scope -> see the Skill suite map in ../olares-shared/SKILL.md (already loaded as the suite prerequisite).

Mental model: settings covers configuration that the Olares Settings SPA exposes — post-install per-app config, mesh / VPN, backup, accounts, system appearance. Lifecycle and runtime live in sibling skills.

13 area sub-trees

The umbrella registers the 12 canonical Settings docs sections, plus a 13th non-canonical me self-service tree. The accelerator section is version-split: gpu on Olares 1.12.5 (legacy HAMI), compute on 1.12.6+ (see the per-area table) — they are the same Settings slot across versions, not two extra areas:

users         appearance   apps          integration   vpn         network
gpu / compute video        search        backup        restore     advanced
+ me (self-service: whoami / version / check-update / sso list)

Shape is always olares-cli settings <area> <verb> (or <area> <noun> <verb> when the area has multiple sub-resources, e.g. vpn devices list, backup plans list).

Per-area --help and references

For every area, start with olares-cli settings <area> --help. References below cover the non-trivial sub-trees:

Role caching + admin/normal floor

A profile carries the role its user has on the Olares instance — owner, admin, or normal — cached locally so the CLI can short-circuit gated verbs without a round-trip. Populated on profile login / profile import, refreshed by olares-cli profile whoami --refresh.

Three whoami aliases, one driver

olares-cli profile whoami
olares-cli settings users me
olares-cli settings me whoami

All three delegate to the same driver — same output, same caching, same --refresh. Never suggest the user "should use the other one" — they are aliases on purpose.

Floor table (admin-gated vs normal)

Soft preflight behavior

• Admin-floor verbs check the cached role and fail fast with role required: this command needs role "<R>" or higher to <verb>, but profile "<id>" is cached as "<r>" before any HTTP call.
• Server-side 401 / 403 (e.g. role changed since last cache write) still gets the same refresh-and-retry hint, even on verbs that don't preflight.
• If role isn't cached yet, preflight is soft: it lets the call through and lets the server be authoritative.
• The standard refresh path is olares-cli profile whoami --refresh — recommend it whenever a settings verb returns a permission-shaped error.

Output convention

Every read verb accepts -o / --output {table,json} (default table):

• table is tabwriter-formatted; columns differ per verb but always print a clear "no X" sentinel when the result set is empty.
• json round-trips the upstream's already-unwrapped data verbatim. Use -o json whenever the agent needs to feed the result into another tool — column ordering, truncation, and human-friendly relabeling only happen in table mode.
• A handful of verbs (video config get, advanced status) downgrade table output to a one-line summary because the upstream config is large; the hint to switch to JSON is printed inline.

Wire-format cheat sheet

Different upstream services return JSON in different envelopes. The CLI normalizes them per-area; this table is the cheat sheet for "what's the wire format for area X" when you need to fish out a non-tabled field via -o json:

Currently-implemented mutating verbs

Verbs marked VERIFIED have been confirmed against a live Olares instance. Verbs flagged UNVERIFIED ship in the binary and work the same way, but have not yet been smoke-tested against a live instance — treat their result as provisional and confirm the outcome after running.

Not yet implemented (and the CLI deliberately does NOT register them):

• App lifecycle (install / uninstall / upgrade / stop / resume / cancel / clone) → use olares-market instead
• Per-app secrets / permissions / providers (Infisical-backed) → admin / chart-side tooling
• Network writes requiring a JWS-signed device-id header (hosts-file set, frp set, ssl enable/disable/update) — note the overlay-gateway writes are NOT in this bucket: they only need Authorization (plus RequireOwner on the gateway master switch), so network overlay enable/disable and overlay app enable/disable ARE implemented
• Containerd registry mutations (registries mirrors put/delete, images delete/prune) — JWS-gated
• Hardware / restart-class (reboot, shutdown, ssh-password, OS upgrade) — JWS-gated via TermiPass QR callback
• Backup plan create / update (needs full BackupPolicy + LocationConfig vector design)
• Restore plan update / non-cancel delete — backup-server has no routes

Don't suggest the deferred verbs — they will error with "command not found".

Security rules

• Never echo <access_token> or any field returned by me sso list into the terminal beyond what the table view shows. SSO tokens identify a TermiPass-bound device session and should never be logged or pasted into chat.
• For writes that take secrets (integration accounts add awss3|tencent, future backup password set), always read the secret from an env var or stdin pipe — never paste it into chat or expand it inline in a suggested olares-cli ... command line.
• users create / users delete are destructive. delete needs the whole word yes unless --yes. delete refuses owner accounts (rejected before DELETE). create always prints the initial password once to stdout — treat transcripts accordingly.
• Read-only verbs do NOT carry "this will change X" prompts. Don't fabricate one for read verbs.
• The profile whoami --refresh recovery path is the only authentication-adjacent action this skill recommends. All other auth recovery belongs in ../olares-shared/SKILL.md.

Common errors

Any auth / token error (token invalidated, no access token, refresh expired) → see the ../olares-shared/SKILL.md auth error recovery table.