Skip to Content
Referenceoo CLI

oo profile

Read or update your own Sunport profile.

Read or update your own Sunport profile: your name and avatar, a code that links your chat account to you, the chat accounts linked to you and unlinking one, and your password.

oo profile get

Show your profile

oo profile get

It also takes the connection options.

oo profile chats

Print your own linked chat accounts as JSON, as Settings > Profile lists them: each with its chat app (platform), its ID there (platform_user_id), its handle and name, and when it was linked. Your limits apply to them, and the bots of the agents you hold open to them.

oo profile chats

It also takes the connection options.

Take one of your own linked chat accounts off you, as Unlink in Settings › Profile does: its messages stop acting as you, and it leaves the allowlists of the bots it reached through you. Name it by its chat app and its ID there, as oo profile chats prints them. It needs your own login, not a key limited in what it may do (full_identity_required), and calls DELETE /api/v1/profile/chat-accounts/APP/ID.

oo profile unlink APP ID
ArgumentRequiredDefaultChoicesDescription
APPyestelegram, mattermost, slack, discord, imessage, line, buzztelegram, mattermost, slack, discord, imessage, line, buzz
IDyesthe account's ID on that app, from oo profile chats

It also takes the connection options.

oo profile update

Change your name

oo profile update [options]
ArgumentRequiredDefaultChoicesDescription
--name NAMEyes

It also takes the connection options.

oo profile avatar

Upload or download your avatar

oo profile avatar [options]
ArgumentRequiredDefaultChoicesDescription
--file FILEnoupload a PNG, JPEG or WebP file
--output OUTPUTnodownload your avatar to a protected file
--overwriteno

It also takes the connection options.

Get a code that links your own Telegram, Mattermost or Slack account to you, as Chat accounts in Settings › Profile does. Send /link CODE in a direct message to Clem's bot in that app, which bots names; on Telegram and Slack, its url, when there is one, opens that direct message. In Mattermost and Slack, Clem's bot answers only people it already lets in, and you put a space before /link. Your limits then apply to that account, and the bots of the agents you can use let it in. The code works once, until expires_at; an account someone without a sign-in holds waits for an administrator to move it (oo people moves). It needs your own login, not a key limited in what it may do (full_identity_required), and calls POST /api/v1/profile/chat-link-code. iMessage has no bot: name the agent with --agent, and text the code to the number the answer gives (line.address; sms_url opens Messages with it typed). From then on that number reaches that agent as you.

oo profile link-code [options] APP
ArgumentRequiredDefaultChoicesDescription
APPyestelegram, mattermost, slack, discord, imessage, line, buzztelegram, mattermost, slack, discord, imessage, line, buzz
--agent AGENTnoiMessage only, and needed there: the agent your number then reaches

It also takes the connection options.

oo profile password

Set or change your own password, as Password in Settings › Profile does. To change it, oo asks for your current password and the new one without showing them, or reads them from standard input, one per line; never put a password in a command's arguments. To set your first password, as when you sign in from the OpenOrange App or with an emailed code, run --send-code: the Sunport emails your account a six-digit code, which --with-code then takes instead of a current password. A protected Sunport sends none (owner_code_unavailable). A forgotten password is replaced after signing in with an emailed code on the sign-in page, or with the link an administrator sends (oo people sign-in-link). A password has 12 to 128 characters, with no spaces at the start or end. Changing it signs you out everywhere else, this oo's login too: when it prints reauthenticate: true, run oo auth login again. It needs your own login, not a key limited in what it may do (full_identity_required), and calls POST /api/v1/profile/password, or with --send-code POST /api/v1/profile/password/code.

oo profile password [options]
ArgumentRequiredDefaultChoicesDescription
--send-codenoemail yourself a code to set your first password
--with-codenoset your first password with the emailed code

It also takes the connection options.

On this page