How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/beclab/olares --skill olares-settingsBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
settings (Olares Settings UI mirror)
Shared front door: load `../olares-shared/SKILL.md` for suite routing, active-profile selection, platform entry points, and the auth proceed/stop gate. Load its auth reference only when login, profile switching, token storage, or auth recovery is actually needed.
Load the shared platform model when version semantics affect the task. Use olares-cli settings <area> <verb> --help for syntax.
When to use
- Mirror Settings UI configuration: users, app entrances/env/domain/policy, integrations, VPN, network, accelerators, search indexing, backup/restore, appearance, video, and advanced status.
- Inspect the current identity, Olares version, updates, or SSO sessions.
- Perform supported post-install configuration writes.
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.Fast paths
| Task | Read | First command |
|---|---|---|
| Find out who this profile is and what version it is on | this file | olares-cli settings me version -o json |
| Read or change one app's configuration | post-install app configuration | olares-cli settings apps get <app> -o json |
| See whether a cloud account is bound | integration accounts | olares-cli settings integration accounts list -o json |
| List the users on this Olares | user lifecycle and password handling | olares-cli settings users list -o json |
Verb index
| Area | Verbs / resources | Read when triggered |
|---|---|---|
me | whoami, version, check-update, sso list | me version is how the version gates other skills carry get answered |
users | me, list, get, create, delete | user lifecycle and password handling |
apps | list/get, entrances, env, suspend/resume | post-install app configuration |
apps (one entrance) | domain, policy, auth-level | per-entrance configuration |
vpn | devices, hidden routes enable/disable, SSH, subroutes (hidden enable/disable), ACL, public-domain-policy | VPN and ACL decisions |
integration | account list/get/add/delete, cookie import/list/rm/validate | integration accounts; cookie store |
backup | plans, snapshots, password | backup decisions |
appearance | get (whole page), language set, widget set, wallpaper list/set/style/upload/delete, layout reset | appearance and wallpaper |
network | reverse-proxy, FRP, hosts-file, overlay gateway/app | Overlay writes are asynchronous and a per-app one can restart the app; gateway master and reverse-proxy set are owner-only |
gpu / compute | legacy GPU list / accelerator list, unbind, set-type | Which one exists depends on the version: gpu on 1.12.5, compute on 1.12.6+ |
video | config get | Read-only. There is nothing here to set |
search | status, rebuild, dirs list/add/rm | `olares-search` for index coverage |
restore | plans list/check-url/create-from-snapshot/create-from-url/cancel | Restores start here, but the snapshots they restore from are listed under backup |
advanced | status, registries, images, system/user env | Admin-only; the env write verbs are env system set and env user set (there is no "env update"), and each takes --var KEY=VALUE and refuses a positional KEY=VALUE. Its image list is what `olares-doctor` annotates with workload references |
Role caching + admin/normal floor
- Roles are
normal,admin, andowner. The active profile caches its role; the server remains authoritative when no cache exists or the role changed. - Admin areas include user administration, accelerator administration, advanced machine state, and privileged VPN/network reads. Overlay gateway master enable/disable and reverse-proxy set are owner-only.
profile whoami,settings users me, andsettings me whoamiare equivalent identity views. Do not redirect between them as if one were more authoritative.
Version and asynchronous decisions
- Olares 1.12.5 uses legacy
gpu list; 1.12.6+ usescompute. - Overlay gateway and per-app overlay operations require 1.12.6+.
appearance widget setandappearance layout resetrequire 1.12.6+;appearance getdegrades instead, reporting the widget section as gated. Five of the seven localesappearance language setaccepts require 1.12.7+.- Overlay writes are asynchronous.
--watchobserves the gateway/app state settling; per-app overlay changes may restart a running app through Market. - Search indexing and rebuild are asynchronous. A successful request does not mean newly indexed content is immediately searchable.
Safety and escalation
- Never expose access tokens, SSO session fields, initial passwords, integration credentials, backup passwords, or VPN secrets in chat or command history.
- Read secrets from stdin or environment variables supported by the selected verb.
- Treat the requested configuration change as task-scope authorisation; do not ask again for each idempotent write in that scope.
- Confirm destructive or wider consequences separately: user deletion, ACL replacement, accelerator unbind/type changes, app restart/stop, index rebuild, and gateway-wide overlay changes.
- Treat app lifecycle requests as `olares-market`, not settings configuration.
- A download or collection that fails for a missing login is a cookie import here (
settings integration cookie), not an `olares-knowledge` problem — see cookie store. - There is no theme verb: a desktop's light/dark state is a cookie the SPA never sends upstream, so no CLI can change it. Report that rather than hunting for a verb or writing
OLARES_USER_THEME, which nothing reads. - Stop when the requested verb is not registered, the role is insufficient, the target user/app/device is ambiguous, or the action requires a JWS/device interaction the CLI cannot perform.
