Skip to the page

Chapter 5

The controls

Every screen and control in the console: the rail, the chat, the mode chip, Connectors, Approvals, Account, the microphone, the attach menu, and the desktop and phone apps.

5.1 The rail

The rail runs down the left edge and stays in view on every page. On a phone (480 px wide or narrower) it becomes a bar along the bottom. Each icon has its name as a tooltip and as its accessible label.

Illustration The rail, top to bottom, with the icons the console draws.
IconGoes toNotes
ConsoleThe chat.The Cockpit mark above the icons also goes there.
Search chatsOpens the Chats panel with the search box ready.On the chat page it opens the panel in place; elsewhere it goes to the chat first.
ApprovalsThe Approvals page (5.6).
ConnectorsThe Connectors page (5.5).A small red dot means at least one connection needs reconnecting.
WorkbenchThe Workbench (chapter 13).Only where it is switched on.
BoardThe project board (chapter 14).Beta, switched on for testers.
AccountThe Account page (5.7).The Modes page and the Workstation page sit under it.
AdminThe administrators' page.Shown only to administrators: access requests, trials and usage.
Profile menuYour name, account management and Sign out.At the bottom of the rail.

The Connectors, Approvals, Modes and Account pages also show a settings list at their left (a row of links on a narrow screen). Modes is reached from that list, from the Account page, or from the chip's panel. In a team, a Team entry is in that list too (chapter 9).

5.2 The chat

The chat is where you work. From top to bottom, left to right:

ControlWhat it does
Chats button (top left)Opens the Chats panel: your list of chats with a search box and a New thread button.
Org chipShows which org or connection this chat uses, for example "Salesforce: Acme Dev (sandbox)", or "No org connected".
Download for Mac / WindowsA button for your own computer's app. It does not appear inside the apps, on phones, or on other systems. See 5.10.
Mode chipShows Sandbox or Production. Opens the mode panel (5.4).
Brain buttonOpens the Brain panel (5.3). A number beside it counts the steps Cockpit has run.
Org picker (above the message box)Appears on a new chat before it has started. Pick the Salesforce org, or the MuleSoft connection, this chat will use. If you have none, it says "No Salesforce org connected" with a link to connect one.
API meter (above the message box)A line such as "API calls this run: 4 of 40 · org allowance left: 94,210" with a small bar. It appears after a tool result reports the numbers, so it is hidden until Cockpit has asked your org something. The 40 is the cap on Salesforce calls in one run.
Message box"Describe the outcome you want...". Enter sends. Shift and Enter start a new line.
MicrophoneDictation. See 5.8.
Send (the up arrow)Sends the message. It is disabled while a reply is being written, if Cockpit is unreachable, if the box is empty, and after your trial has ended.
Illustration The message box. The plus button on the left is the attach menu, which is arriving (5.9).

Under the box, one line repeats the safety promise: "Every write the Copilot proposes waits for your approval. Nothing ships without you."

A banner at the top of a chat says when Sandbox is on: "Sandbox is on: Cockpit can read your connected systems but nothing can be changed. If you ask for a change, it will say so and change nothing." If only that chat has been made Sandbox, the banner says that chat stays Sandbox.

While the Copilot works, you see its steps stream into the chat. If your connection drops during a run, the console reconnects to the run by itself with growing pauses, so a deploy or a network blip does not lose the answer.

ADVISORY · Slash command

Typing /discovery and pressing Enter runs the Org Discovery Report on the chat's org (or the org you picked). No AI model is involved in running it, so it does not need the AI consent. See chapter 7.

5.3 The Chats panel and the Brain panel

Figure 10. The Chats panel with a few chats. Capture details are item 10 in the list of screenshots to capture. Call-outs to draw: 1 New thread; 2 Search chats; 3 Sandbox tag; 4 Options menu.
  • New thread starts a chat. Search chats finds earlier ones by their words.
  • Each chat has an Options menu with Rename, Delete, and Make this chat sandbox. After you use the last, the menu reads "This chat is Sandbox" and the chat carries a green Sandbox tag. A chat can only be tightened this way, never loosened.
  • An amber dot beside a chat means it is waiting for your approval.
  • Delete asks first. The chat leaves your list at once and is removed for good after 30 days.

Under 900 px wide, the Chats and Brain panels open as drawers over the conversation. Escape closes a drawer.

Figure 11. The Brain panel on the Activity tab. Capture details are item 11 in the list of screenshots to capture. Call-outs to draw: 1 Tabs: Activity, Approvals, History, Settings; 2 A tool line; 3 API usage; 4 Read-only badge.

The Brain panel says who is working and what it did. It has four tabs:

TabWhat it shows
ActivityOne line per tool Cockpit ran for you, with a time. Empty until something is read.
ApprovalsHow many approvals are waiting on you in this thread, and a link to the Approvals page.
HistoryPlans and approvals for this thread.
SettingsLinks to Connectors and Account.

The panel also shows API usage for your Salesforce org ("No Salesforce API calls in this thread yet" until one is made) and a Safety badge: "Read-only" with "Sandbox is on: nothing can be changed.", or "Read + write" with "Production mode (read + write): every change asks for your approval first."

5.4 The mode chip, the mode panel and the Modes page

Illustration The mode chip in both states. Wide windows show the long wording; a phone shows Sandbox or Production only.

Click the chip to open the mode panel. It has a master switch and a row for each connector.

Figure 12. The mode panel opened from the chip. Capture details are item 12 in the list of screenshots to capture. Call-outs to draw: 1 Master switch; 2 A connector row; 3 Mode settings link.
  • Production mode (read + write) is the master switch. Turning it on asks you to confirm: "Switch to Production mode (read + write)?" The confirmation says Cockpit will be able to make changes where a write action exists, that every change still asks for your approval, that the mode does not describe what kind of org is connected, and that you can switch back to Sandbox at any time with no confirmation. The buttons are Switch to Production mode and Stay in Sandbox.
  • Per connector rows (Salesforce, MuleSoft, Slack, GitHub, Postman, Workstation) show, in Sandbox, "read only in Sandbox". In Production mode, each shows "can write, each write asks for approval" with a switch you can turn off, which changes it to "read only (you switched writes off)". A connector with no write action shows "read only (no write actions yet)" and its switch is locked.
  • The Modes page has the same switches, a note that a new chat follows the account mode, a count of requests held back by a mode in the last 30 days ("These are not errors: nothing was changed."), and a list of recent mode changes with times.

ADVISORY

Every Connectors card carries a small tag that tells you what Cockpit can do with it right now: "Read only (Sandbox)", "Read + write", "Read only (writes off)" or "Read only (no write actions yet)". It describes Cockpit, never the connected org.

5.5 Connectors

Open Connectors from the rail. The page explains that you have one connection per platform, except Salesforce and MuleSoft, where you can connect several and pick one for each chat. Google is how you signed in.

Figure 13. The Connectors page before anything is connected. Capture details are item 13 in the list of screenshots to capture. Call-outs to draw: 1 Settings list at the left; 2 Search; 3 Connected and Available tabs; 4 Salesforce card; 5 A Connect button.
  • A Search box filters by name.
  • Two tabs, Connected and Available, with counts. The page opens on Available until something is connected.
  • The Salesforce and MuleSoft cards sit above the tabs, because each can hold several connections.
  • Each other connector is a row. Click its name to open its detail: Identity (who the connection is), Health (status, last test, connected since, last used, token expiry, last error) and App (which app, the saved key and whether a secret is saved, and the scopes, summarised as "N permissions (show all)").
  • A row shows connected or not connected, its capability tag, and a Connect button when it is not connected.
  • A connected row has Test, Reconnect, Disconnect and, for connectors you connect with your own app or key, Delete. Test makes one real read-only call and reports "Test passed" or "Test failed" with a reason. Each of Disconnect and Delete asks you to confirm.

The Salesforce card lists every org you connected, each with its name, org-type chip, a health label (Working, Needs reconnect, or Not checked yet), when it was connected and last used, and buttons:

Figure 14. The Salesforce card with a connected org. Capture details are item 14 in the list of screenshots to capture. Call-outs to draw: 1 Add Salesforce org; 2 Org name and type chip; 3 Health label; 4 Rename, Reconnect, Disconnect.
  • Add Salesforce org opens the four-step guide of chapter 6. Setup guide opens the same guide.
  • Rename gives an org a name you recognise (up to 120 characters).
  • Reconnect replaces that org's sign-in. Disconnect keeps the org's chats but they cannot read it until you reconnect.
  • Run discovery report (where switched on) reads the org once and writes the Org Discovery Report into a chat. Hovering it says "Reads this org and writes a report. It changes nothing in Salesforce." The finished report can be downloaded as Markdown (.md) or as its tables in CSV.

The MuleSoft card works the same way, with Add MuleSoft connector, and shows the region and organisation of each connection. A red notice at the top of a card with "Needs reconnect" means the provider refused the saved sign-in.

ADVISORY

When you come back from connecting a system, the page tells you what happened in one line (for example "GitHub is connected.") and opens that card. Chapter 10 lists the messages for when it did not work.

5.6 Approvals

The Approvals page lists every approval card waiting across all your chats, grouped by chat, newest first, with a Refresh button. It says: "Every write the Copilot proposes waits here. Nothing ships without you." When nothing is pending it shows "All clear" and "No pending approvals." with a link back to the console.

Figure 15. The Approvals page with nothing pending. Capture details are item 15 in the list of screenshots to capture. Call-outs to draw: 1 Refresh; 2 All clear message.

Each card has the layout shown in chapter 2: summary, exactly what will run, fingerprint, tags and the target. Approve and Deny decide it. A decided card shows who decided and when. After your trial has ended, both buttons are disabled and a line says so.

ADVISORY

Only a card still waiting appears here; decided cards remain in the chat they came from and in the Approvals tab of the Brain panel.

5.7 Account

Figure 16. The Account page. Capture details are item 16 in the list of screenshots to capture. Call-outs to draw: 1 Sign out; 2 Standing approvals; 3 AI processing; 4 Downloads; 5 Usage; 6 Delete account.
SectionWhat it holds
IdentityYour name, email and avatar, and a Sign out button.
ConnectionsA link to Connectors.
ModesA link: "Sandbox and Production".
Standing approvalsTools you chose to "Always allow", each with a Revoke. It says "None. Cockpit asks for your approval every time." until you allow one. Standing approval is offered only for plans and reads, never for writes.
AI processingThe provider list you agreed to, a link to the privacy policy, and Withdraw consent.
Cockpit appA link to open the app, where that is available, or to get it.
DownloadsCockpit for Mac and Cockpit for Windows (5.10).
UsageInput tokens and Output tokens, totals for your account.
Delete accountDeletes your account and everything in it, after you type the confirmation word. It cannot be undone.

5.8 The microphone

The microphone beside the send button dictates into the message box, using your browser's or phone's own speech recognition. Cockpit's servers do not do the speech recognition. The button is hidden where the browser has none.

  1. Click the microphone. Allow the microphone for this site if your browser asks.

    You should see The button changes to Stop listening, and a note says "Listening... tap the microphone again when you are done."

  2. Speak, then click the microphone again.

    You should see Your words are added after anything already in the box, with a space between. Nothing is sent: you read it, then press Send.

Figure 17. The message box while the microphone is listening. Capture details are item 17 in the list of screenshots to capture. Call-outs to draw: 1 Microphone button (listening); 2 Listening note.
MessageMeaning
Cockpit cannot use the microphone. Allow it for this site in your browser or phone settings, then try again.Permission was refused. Change it in the browser's site settings.
I did not hear anything. Try again, closer to the phone.Nothing was recognised.
Voice input is not working right now. You can still type.The browser's recognition failed. Type instead.

CAUTION

Check dictated names and Ids before you send. Speech recognition mishears record names, and an approval later depends on the exact text.

5.9 The attach menu (arriving)

ARRIVING

The plus button beside the message box is built but switched off for most accounts. If your message box has no plus, that is expected. What follows describes it so that you know what is coming.

  • Plus opens a small menu: Salesforce org (with a count such as "2 connected"), or Connect something new.... With no org connected, the first entry reads Connect a Salesforce org.
  • Choosing Salesforce org opens a sheet, Attach a Salesforce org: pick the org, give it a short name (lower-case letters, digits and dashes, up to 24 characters, starting with a letter or digit; suggestions are dev, qa and uat for a sandbox and prod for Production), and press Attach.
  • The sheet shows Access as Read only; "Read and write" is greyed out with the note "Writing through an attached org comes later. For now it is read only."
  • A chat can have up to 4 orgs attached. They appear as chips such as "dev · Salesforce · read only", each with a Detach button, and you can then ask the Copilot to compare them by name.

WARNING

Attaching an org makes the chat Sandbox, and a chat never goes back. The sheet warns you: "Attaching makes this chat read only. It stays read only, so start a new chat if you need to change something."

5.10 The desktop apps

Cockpit for Mac and Cockpit for Windows are the same console in a window of its own. They are beta downloads. The download buttons appear for approved accounts only, on the Account page and in the chat's top bar, and not inside the apps.

Figure 18. The Mac and Windows download cards. Capture details are item 18 in the list of screenshots to capture. Call-outs to draw: 1 Download button; 2 Install steps.
MacWindows
SystemApple silicon.Windows 10 or 11, 64-bit.
ButtonDownload for Mac.Download for Windows.
InstallOpen the downloaded DMG and drag Cockpit to Applications. Open it from Applications; the first time, macOS asks whether to open an app downloaded from the internet: click Open.Run the downloaded installer. It installs just for you and does not ask for an administrator password. Open Cockpit from the Start menu or the desktop shortcut.
Sign inClick Enter Cockpit. Your browser signs you in with Google and hands you back to the app.The same hand-off, through the cockpit:// address.

The card for your own system comes first with the main button; the other follows as a second choice.

Use the Cockpit menu

  1. In the app, open the Cockpit menu in the menu bar. On Windows the bar is hidden until you press Alt.

    You should see New chat, Connections, Workbench and Approvals, each with its shortcut. The same menu is in the Mac and Windows apps.

  2. Choose an entry, or press its shortcut.

    You should see New chat starts a chat. The others open that page in the app's window.

Figure 19. The Cockpit menu of the desktop app. Capture details are item 19 in the list of screenshots to capture. Call-outs to draw: 1 New chat; 2 Connections, Workbench, Approvals; 3 Shortcuts.
Desktop shortcuts
MacWindowsTo
Command + NCtrl + NNew chat
Command + Shift + CCtrl + Shift + CConnections
Command + Shift + BCtrl + Shift + BWorkbench
Command + Shift + ACtrl + Shift + AApprovals

The menu bar also has the usual Edit, View and Window menus, and a Help menu with Cockpit Manual (opens this manual in the app), Check for Updates and Copy Diagnostics. The zoom, reload and close keys are the ones every app uses. Check for Updates tells you only when a newer version exists; it never installs anything. Where update checks are not switched on, it opens the Cockpit website instead.

Copy Diagnostics for support

  1. Choose Help, then Copy Diagnostics.

    You should see A message: "Diagnostics copied. App, system and service versions are on your clipboard. They contain no account details."

  2. Paste into your message to support (Appendix C).

Figure 20. The Diagnostics copied message in the desktop app. Capture details are item 20 in the list of screenshots to capture. Call-outs to draw: 1 Help menu entry; 2 Diagnostics copied message.
It containsIt does not contain
The app version, and whether it is installed.Your name, email or account.
Your system and its version and type, and the versions of Electron, Chromium and Node the app is built on.Any token, password, key or sign-in ticket.
The website host the app talks to (only the host name).Any page address, path or query, chat text or connection.
The version of the Cockpit website and the Brain service, as they report themselves, and the time.Anything you have connected or approved.

A line reads "unknown" when it could not be found, for example the service versions when you are offline.

If Cockpit cannot be reached

  1. Open the app with no internet, or lose the connection while it is open.

    You should see A plain screen: "Cockpit can't be reached. Check your internet connection. Cockpit will try again by itself." with a Try again now link.

  2. Reconnect, or press Try again now.

    You should see Cockpit opens as before. Automatic tries come 5 seconds apart at first and then further apart, up to once a minute.

Figure 21. The Cockpit can't be reached screen in the desktop app. Capture details are item 21 in the list of screenshots to capture. Call-outs to draw: 1 Heading; 2 Try again now link.

If the page itself stops working, the app reloads it, up to three times in a minute, and then leaves you on that screen. The app also remembers its window size and place, and reopens in them; if a screen has been unplugged it opens on one that is there. The window cannot be made smaller than 900 by 600.

ADVISORY

Two extras in the apps are switched off unless switched on for you: a count of waiting approvals in the window title, with one notice when a new one arrives, and the update check. Do not expect them unless support told you they are on.

ADVISORY

The Windows installer is signed. The Windows card would carry a SmartScreen note ("click More info then Run anyway") only for an unsigned build; the current build shows none.

5.11 Phones

ARRIVING

iPhone and Android apps are coming. They are not available to download. Until then, the console works in a phone's browser: the rail becomes a bottom bar, the Chats and Brain panels become drawers, and controls are at least 44 px tall.

Figure 22. The console on a phone-width screen. Capture details are item 22 in the list of screenshots to capture. Call-outs to draw: 1 Bottom rail; 2 Short mode chip; 3 Message box.

Controls checklist

Controls checklist

  • I can find the mode chip on the chat and on the Connectors page.
  • I opened the Chats panel and the Brain panel and know what each shows.
  • I know where the Approvals page, the Modes page and the Account page are.
  • I tried the microphone, or I know it is optional.
  • I know the plus button is arriving and may not be on my screen.