Skip to Content
Referenceoo CLI

oo sunport

Updates, privacy, data sharing, maintenance access, server disk and other Sunport settings.

Read and change the Sunport's own settings, as Settings › Updates, Privacy, Data sharing, Megabrain, Maintenance access and Server disk do. Each command prints the setting as JSON (oo sunport disk prints its finished job); with an option it changes it, and every change is audited.

oo sunport disk

The Sunport's own server disk, as Settings › Server disk shows it: the disk its database, agents' workspaces and release images live on. Only a Sunport on OpenOrange's own servers can grow it for now. Each command runs a job and follows it to its end: exit 0 done, 1 failed, 124 timed out while the job continues (oo jobs wait JOB_ID). Reading it needs hosts.read and growing it hosts.manage, both with jobs.create; only an administrator grows it, and Clem's request waits for an administrator's click.

oo sunport disk [COMMAND]

It also takes the connection options.

oo sunport disk show

Print the disk as the job's result: its size (diskGb), its size's disk (profileGb), the GB beyond it (extraGb, billed at priceUsdPerGbMonth: extraMonthlyListUsd a month), the sizes it can grow to now with the monthly price of each (sizes), the biggest (maxGb), whether a bigger disk applies while it runs (growsLive) and whether another job runs on the Sunport (busy). diskGb is null where it can't grow yet.

oo sunport disk show [options]
ArgumentRequiredDefaultChoicesDescription
--no-waitnoprint the accepted job instead of following it
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport disk grow

Grow the disk to GB, one of the sizes oo sunport disk show lists. It never shrinks again, and the GB beyond its size's disk are charged each month to the prepaid balance, counting toward the monthly server budget. --price is that size's monthlyListUsd, which you accept; without it the job fails with the price (sunport_disk_price_confirmation_required). --restart restarts the Sunport so the bigger disk applies now: everything here is offline for about 20 seconds, then chats, agents and the dashboard pick up again. Without it, the disk applies when the Sunport next starts. The job ends once OpenOrange took the grow (platformJobId, fromGb, toGb, applies: live, restart or next_start); oo sunport disk show then says busy until it is done. It asks first, or takes --yes.

oo sunport disk grow [options] GB
ArgumentRequiredDefaultChoicesDescription
GByesthe new size in GB
--price USDnothat size's monthly price in USD (monthlyListUsd), which you accept
--restartnorestart the Sunport so the disk applies now: offline for about 20 seconds
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat
--no-waitnoprint the accepted job instead of following it
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport logs

Read main-server diagnostics or selected agent VM gateway logs, lifecycle events and service settings. Only administrators, and Clem in an administrator's own turn, may run this. Request and response content is never shown. Logs and events default to the last hour; the maximum window is 6 hours. The command submits a job and follows it to its end.

oo sunport logs [options]
ArgumentRequiredDefaultChoicesDescription
--since 1h|30m|ISOno1hwindow start (default: 1h ago)
--until ISOnowindow end (default: now)
--service SERVICEnoagent:<id> reads its VM; logs accepts main-server services; properties accepts jobs/updater/clem; repeat to narrow
--grep GREPnoliteral text to match, at most 200 characters
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport events

Read main-server diagnostics or selected agent VM gateway logs, lifecycle events and service settings. Only administrators, and Clem in an administrator's own turn, may run this. Request and response content is never shown. Logs and events default to the last hour; the maximum window is 6 hours. The command submits a job and follows it to its end.

oo sunport events [options]
ArgumentRequiredDefaultChoicesDescription
--since 1h|30m|ISOno1hwindow start (default: 1h ago)
--until ISOnowindow end (default: now)
--service SERVICEnoagent:<id> reads its VM; logs accepts main-server services; properties accepts jobs/updater/clem; repeat to narrow
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport storage

Read main-server diagnostics or selected agent VM gateway logs, lifecycle events and service settings. Only administrators, and Clem in an administrator's own turn, may run this. Request and response content is never shown. Logs and events default to the last hour; the maximum window is 6 hours. The command submits a job and follows it to its end.

oo sunport storage [options]
ArgumentRequiredDefaultChoicesDescription
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport properties

Read main-server diagnostics or selected agent VM gateway logs, lifecycle events and service settings. Only administrators, and Clem in an administrator's own turn, may run this. Request and response content is never shown. Logs and events default to the last hour; the maximum window is 6 hours. The command submits a job and follows it to its end.

oo sunport properties [options]
ArgumentRequiredDefaultChoicesDescription
--service SERVICEnoagent:<id> reads its VM; logs accepts main-server services; properties accepts jobs/updater/clem; repeat to narrow
--timeout TIMEOUTno300.0
--interval INTERVALno2.0

It also takes the connection options.

oo sunport updates

Without options, print the update policy: whether OpenOrange's updates install automatically (automatic), the weekly windows they may start in (windows), the time zone those and the hold date follow (timeZone), the day before which none starts (holdUntil), whether security updates wait for the windows or install at once (security), who changed it and when, and its revision. --hold puts updates on hold and --automatic lets them install again. Each --window adds a window: its days (mon-fri, or sat,sun; every day without them) and its HH:MM times; one that ends at or before its start runs past midnight, and 00:00-00:00 is the whole day. --any-time lifts the windows. The old --window START-END in whole UTC hours still works and sets the time zone to UTC. An update already running may finish, and manual updates are not affected. Reading needs settings.read and changing settings.write.

oo sunport updates [options]
ArgumentRequiredDefaultChoicesDescription
--automaticnoinstall updates automatically
--holdnoput updates on hold
--window WINDOWno[DAYS] START-END, once per window, such as mon-fri 22:00-04:00
--any-timenoat any time
--time-zone ZONEnothe IANA time zone, such as Europe/Berlin
--hold-until YYYY-MM-DDnostart no automatic update before this day
--no-hold-untilnodrop the hold date
--security SECURITYnowindow, asapwhether security updates wait for the windows or install at once

It also takes the connection options.

oo sunport vm-agents

Without options, print where VM agents stand, as Settings › Updates shows it: on, or refusal (why they can't be turned on, with a code and a message), and last, how the last request ended. --enable asks for them. OpenOrange decides, and refuses through a hold of its own. It can't be turned off again, and the dashboard and Clem restart during it. It costs nothing by itself: each VM is then billed by the hour and counts toward the monthly server budget. Reading needs settings.read and asking settings.write; Clem's request waits for an administrator's click, and an agent's own key is refused.

oo sunport vm-agents [options]
ArgumentRequiredDefaultChoicesDescription
--enablenoask to turn VM agents on
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport update-now

Without options, print what an update now would do, as Settings › Updates shows it: available (the release it would install), or refusal (why not, with a code and a message), and last, how the last request ended. --install asks for that release. While agents are working (working: each agent with a run in progress, a chat and the background work it holds open, a chat app's turn or a scheduled run), the update waits on this Sunport until none is (waiting: its release, which agents it waits for and since when, and installing once it went), and each web chat with running work is told once to finish or stop at a safe point; from then until the update ends, new web chat messages are refused with one sentence. --now installs at once over running work, for an urgent fix: that work stops. --cancel drops an update that still waits. With --snapshot-first, every machine is snapshotted before anything is installed (snapshot says whether that's offered, and the update never runs without the snapshot asked for). OpenOrange decides, and picks the release: the newest on this Sunport's channel, never another. It refuses through any hold, whether OpenOrange's or this Sunport's own (oo sunport updates --hold), and while a rollout is stopped. While OpenOrange is still trying the release on its first Sunports (a refusal such as release_rolling_out, with available naming it), --install waits: the request starts by itself the moment it may, within the hour. The request reaches it within a minute; follow the update with oo sunport update-history. The dashboard and Clem restart during it, and each agent restarts in turn. Reading needs settings.read and asking settings.write; Clem's request waits for an administrator's click.

oo sunport update-now [options]
ArgumentRequiredDefaultChoicesDescription
--installnoask for the release on offer now
--nownowith --install: install at once, stopping agents' running work, for an urgent fix
--cancelnodrop an update that still waits for agents' work
--snapshot-firstnowith --install: snapshot every machine first
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport update-history

Print the release installed now (installed) and the last installs and updates as JSON, newest first (updates): each with its kind, the release it went from and to, when it started and finished, and how it ended, with a failed one's phase, exit code and reason. Needs sunport.read.

oo sunport update-history [options]
ArgumentRequiredDefaultChoicesDescription
--limit Nnoonly the latest N updates

It also takes the connection options.

oo sunport desired-state

Print what OpenOrange manages for this Sunport and whether the Sunport runs it, as Managed by OpenOrange in Settings › Updates shows it: in_sync, differences or not_reported overall (state), how many fields are pending or differ (differences), when the Sunport last checked (checkedAt), and each field with its desired value and status: applied, pending (on its way), drift (the next update or redeploy applies the desired value) or not_reported. Read-only: OpenOrange and this Sunport's own settings change the fields. Needs sunport.read.

oo sunport desired-state

It also takes the connection options.

oo sunport health

Print the Sunport's health as JSON: the release installed now and the latest updates with how each ended (release, updates), whether its configuration is in sync (configuration), the last 24 hours' model requests and failures per model with p95 and the commonest error code (requests), each service's state, health and this month's calls and failed calls (services), and each server's state and when it was last seen (servers). A part that can't be read now is null. No messages, keys, people or spend. Needs sunport.observe, which an administrator may give an agent connected from elsewhere (oo permissions add --agent AGENT --permission sunport.observe:*); every read is audited.

oo sunport health

It also takes the connection options.

oo sunport privacy

Without options, print the privacy settings for the text of model requests and replies: how many days it is kept (retentionDays: 0 keeps none, forever disables age clearing), whether administrators can open other people's (adminView; everyone can always open their own), and whether the Sunport holds its own key to open encrypted content (sunportKey). Usage and billing numbers are always kept. Content older than a new period is removed within the next quarter hour. Before the first change, give both options. Reading needs settings.read and changing settings.write.

oo sunport privacy [options]
ArgumentRequiredDefaultChoicesDescription
--retention RETENTIONno0, 7, 30, 90, foreverdays to keep it: 0, 7, 30, 90 or forever
--disk-budget DISK_BUDGETno10, 25, 40, nonemaximum share of server disk for request content (default 25 percent), or none
--admin-view ADMIN_VIEWnoon, offwhether administrators can open other people's

It also takes the connection options.

oo sunport usage-summary

Daily usage counts sent with the heartbeat (settings.read)

oo sunport usage-summary

It also takes the connection options.

oo sunport data-sharing

Without options, print what this Sunport shares with OpenOrange: what it always sends and why (required), the optional sharing an administrator may turn on (optional), and the choices now (dataSharing), each off until an administrator turns it on; OpenOrange refuses those without it. Automatic key handoff is the exception, on until an administrator turns it off: the Sunport's server then refuses to hand its keys over, and keyHandoffs lists what it answered each time it was asked. Error reports follow the Sunport's tier until an administrator chooses: on for a public Sunport (from a sign-up), off for an enterprise one; errorReportsDefault says whether it is still the default. Nightly backups to OpenOrange are their own setting: oo backups nightly. Each option turns one choice on or off and leaves the others as they are; turning one on asks for confirmation. Every change is audited, and one Clem asks for waits for an administrator. Reading needs settings.read and changing sunport.root.

oo sunport data-sharing [options]
ArgumentRequiredDefaultChoicesDescription
--diagnostic-evidence DIAGNOSTIC_EVIDENCEnoon, offwhether OpenOrange may collect redacted logs from the server to investigate a problem
--investigator-access INVESTIGATOR_ACCESSnoon, offwhether an OpenOrange investigator may read conversations, files and personal data
--ai-triage AI_TRIAGEnoon, offwhether this Sunport's alerts may go to an AI model that suggests a cause
--key-handoff KEY_HANDOFFnoon, offwhether the server may hand the Sunport's keys over, sealed, to the server that takes the Sunport over (on by default; off means such a move needs your recovery file)
--error-reports ERROR_REPORTSnoon, offwhether the server may send its own errors, scrubbed and counted by hour, with its health check-in
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport keys

Without options, print who holds this Sunport's keys: held is true once OpenOrange keeps no copy, with since when, and the answer to the last request. To hold them yourself, --export saves the recovery file (the keys, and a new password for the nightly backups), then --hold sends that file back and OpenOrange deletes its copy for good. Restoring the Sunport onto a new server then needs your recovery file if the Sunport can't hand its keys over itself. Only the Sunport's owner does this, signed in as themselves (where there is no owner, an administrator with sunport.root); never with an API key or through Clem. Every step is audited.

oo sunport keys [options]
ArgumentRequiredDefaultChoicesDescription
--export FILEnosave the recovery file as FILE, which must not exist yet
--hold FILEnosend back the recovery file you exported last, to hold the keys
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport job-cancellation

Without options, print whether experimental job cancellation is enabled (jobs.read). --set on or off changes the Sunport's default-on switch (sunport.root), with an audit entry. An explicit off stays off across updates. The host administrator's OPENORANGE_JOB_CANCELLATION_ENABLED=1 overrides off. A request never deletes VMs or data, and already-dispatched work may finish normally.

oo sunport job-cancellation [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offenable cancellation requests, or not

It also takes the connection options.

oo sunport host-forget

Without options, print how many minutes a server OpenOrange doesn't manage must go unseen before oo vm forget forgets it (unseenMinutes, hosts.read): 1440, 24 hours, unless the Sunport set its own. --unseen-minutes changes it (sunport.root), from 5 to 43200, with an audit entry; a test Sunport shortens it for an end-to-end run, and 1440 puts it back.

oo sunport host-forget [options]
ArgumentRequiredDefaultChoicesDescription
--unseen-minutes MINUTESnothe new threshold, 5 to 43200

It also takes the connection options.

oo sunport dashboard-chat

Without options, print whether managed dashboard chat is on (agents.dashboard). --set on or off saves the Sunport's choice (sunport.root), with an audit entry. Without a saved choice it follows OpenOrange's, and is off without that. Existing dashboard and Chat permissions still apply. The host administrator's OPENORANGE_DASHBOARD_MANAGED_CHAT=on overrides off.

oo sunport dashboard-chat [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offenable managed dashboard chat, or not

It also takes the connection options.

oo sunport schedule-approvals

Without options, print the default-off schedule owner approvals switch (agents.chat). --set on or off changes it (sunport.root), with an audit entry. A linked current owner must still approve each DM session before it may read all reminder text and cancel the agent's schedules for up to 30 minutes. The host administrator's OPENORANGE_SCHEDULE_OWNER_APPROVALS=1 overrides off.

oo sunport schedule-approvals [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offenable owner approvals, or not

It also takes the connection options.

oo sunport megabrain

Turn Megabrain, the Sunport's shared sources and packets of earlier work, on or off, and print its state as oo megabrain status does: whether it is on (enabled), whether its content is encrypted with the Sunport's content key (protected), when it was last turned on or off (changedAt), where it makes meaning (meaning) and, while it's on, how many items wait to be read or indexed and why indexing is stuck when it is (index: pending and error). A Sunport installed from this release starts with it on; an older one keeps it off until an administrator turns it on, and while it's off, its reader and search model don't run. While nobody has chosen, once someone sends a file in a web chat or searches it, administrators are offered it (offer: file or search) until a setting is chosen or one answers offer off, which stops the offer for good. Turning it off keeps what it holds, and oo megabrain delete-all deletes that. meaning local, the default, finds by meaning with a model on the Sunport, so no content leaves it; meaning hosted uses Google's Gemini Embedding 2 through the Sunport's model proxy, which finds more, and sends Google the text of every passage and the words of every search; it is confirmed once. Either way every item is read again, and search finds by meaning as it goes. chat-files on keeps the files people send in the web chat, and the files agents show them there, for each person, unless they turn theirs off (oo megabrain chat-files); off stops it, and what was kept stays. A Sunport keeps them from when Megabrain is turned on; one that had Megabrain on before Megabrain kept chat files keeps them only once turned on here. Changing any of it needs sunport.root; a change Clem asks for waits for an administrator. oo megabrain status reads it, as any signed-in caller.

oo sunport megabrain [options] state [value]
ArgumentRequiredDefaultChoicesDescription
stateyeson, off, meaning, chat-files, offerturn it on or off, move its meaning, keep chat files or not, or stop its offer
valuenolocal, hosted, on, offwith meaning: local, on the Sunport (the default), or hosted, by Gemini through the model proxy; with chat-files: on or off; with offer: off
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport maintenance

Without options, print maintenance access: whether OpenOrange can sign in to this Sunport's server now (open), how long each grant lasts (duration: 1h, 24h or until-closed) and the recent grants. --open lets it in as an administrator for one hour, or for as long as --for says, and is confirmed once; --end ends that at once. A grant open until closed lasts until someone ends it: its expiresAt is how far ahead the Sunport keeps renewing it, about a day. Reading needs settings.read; opening and ending need sunport.root.

oo sunport maintenance [options]
ArgumentRequiredDefaultChoicesDescription
--opennolet OpenOrange in, for one hour unless --for says otherwise
--endnoend its access now
--for DURATIONno1h, 24h, until-closedhow long --open lets it in: 1h (the default), 24h or until-closed
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo sunport quota

`show` prints the team's limits as OpenOrange sent them (caps: agent and service VMs, published names and new names a week; null for a Sunport whose team has none) and the newest requests for more, each pending, approved with what was granted, denied, or refused when OpenOrange would not take it, with the OpenOrange team's note. `request` asks for more: each option is the team's new total, higher than now, and --reason says why. One request waits at a time. Anyone in the Sunport may ask, and reads the limits and their own requests; billing.read reads everyone's. Clem, or an agent in a chat the person started, asks for them. The OpenOrange team emails the answer to whoever asked.

oo sunport quota [COMMAND]

It also takes the connection options.

oo sunport quota show

Print the team's limits and the newest requests for more

oo sunport quota show

It also takes the connection options.

oo sunport quota request

Ask the OpenOrange team for higher limits

oo sunport quota request [options]
ArgumentRequiredDefaultChoicesDescription
--vms VMSnothe team's new total of agent and service VMs
--names NAMESnothe team's new total of published names
--weekly-names WEEKLY_NAMESnohow many new names the team may publish in 7 days
--reason REASONyeswhy the team needs more, in your words

It also takes the connection options.

oo sunport console-password

Without options, print whether this Sunport's server has a console password: the root password for the hosting provider's console, which doesn't work over SSH. --reveal prints it, and each reveal is recorded in the audit log. Reading needs settings.read; revealing needs sunport.root.

oo sunport console-password [options]
ArgumentRequiredDefaultChoicesDescription
--revealnoprint the password

It also takes the connection options.

oo sunport owner-hop

Without options, print whether the Sunport's owner may open it from their OpenOrange account with no password here (enabled), and who the owner is, with whether their login has a way in of its own here, a password or a passkey (owner.localSignIn). Each opening uses a one-time pass that lasts a minute and works only for the owner. Turning it off signs nobody out, and is refused (owner_needs_local_sign_in) until the owner's login has a password or passkey here, so they can still get in if OpenOrange can't be reached; turning it on never is. Emailed sign-in codes have their own switch: oo sunport sign-in-codes. It needs an administrator's own login with access.manage; changing it needs unrestricted credentials. A Sunport that can't be opened from the app answers not_configured.

oo sunport owner-hop [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offallow opening from the app, or not

It also takes the connection options.

oo sunport sign-in-codes

Without options, print whether anyone with a login here, the owner included, may sign in with a one-time code sent to their email, as Settings › Sign-in shows it (enabled; on unless an administrator turned it off). It is apart from opening the Sunport from the OpenOrange app (oo sunport owner-hop). Turning it off stops every code at once and signs nobody out; every change is audited. It needs an administrator's own login with access.manage; changing it needs unrestricted credentials.

oo sunport sign-in-codes [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offlet people sign in with an emailed code, or not

It also takes the connection options.

oo sunport sign-in

Without options, print whether members may sign in here with their OpenOrange account (enabled; off unless an administrator turned it on), why this Sunport can't take it when it can't (unavailable: protected, not_configured, not_https or no_customer_app), and the logins linked to an OpenOrange account or waiting for approval (links). A login is linked once, by its invitation with the same verified email, its own password or an administrator's approval; never by email alone. Everyone sees their own link and may remove it; administrators with access.manage see every link, approve requests and remove anyone's, and turning it on or off needs unrestricted credentials. Removing a link ends that login's sessions; the login stays.

oo sunport sign-in [options]
ArgumentRequiredDefaultChoicesDescription
--set ENABLEDnoon, offlet members sign in with OpenOrange, or not
--approve ACCOUNTnoapprove the request of this login (its accountId)
--unlink ACCOUNTnoremove this login's link, or turn its request down
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

On this page