Optimizely Opal Desktop app

Opal Desktop is available as a desktop app for Windows, macOS, and Linux. 

To install, complete the following steps:

1. Select the installer for your operating system:
   • Windows – Click the download link. 
   • macOS – Click the download link. 

     • Alternatively, run the following commands in a terminal with Homebrew: 

       brew tap optimizely/agent-platform
       brew trust optimizely/agent-platform
       brew install optimizely-agent-platform  

   • Linux – Run the following command in a terminal. Currently, Opal Desktop supports Debian on Linux only.  

     curl -fsSL https://dl.opal.optimizely.com/desktop/linux/deb/install.sh | bash

2. Run the installer and follow the on-screen prompts to complete the installation.

Log in and select a product instance

1. Launch Opal Desktop.

2. Click Log in.

   

3. Log in with your Opti ID credentials.

   

4. Select your Organization and product Instance from the corresponding drop-down lists. Switch between organizations and Opal instances from the navigation bar after logging in.

   

5. Click Go.

6. Work with Opal Chat the same way you do in the browser:

   • Invoke agents.
   • Create and edit images.
   • Manage the flow of a conversation.
   • Choose between conversation modes.

   

Opal Desktop capabilities

Optimizely Opal Desktop is a native application that runs Opal on your computer instead of in a browser tab. Opal Desktop lets you do the following:

• Keep Opal open alongside your other applications.
• Receive a desktop notification when a response finishes.
• Give agents access to files and folders on your own computer through local tools.

Local file and folder tools

Opal Desktop gives agents access to files and folders on your computer through local tools. These tools are not available in Opal Chat in a browser.

Agents use the following local tools when a conversation references a local path, project, or file: 

• List directory – Browses files and subdirectories in a local folder. Returns file names, types, sizes, and modification dates.
• Read local file – Reads the contents of a file on your computer.
• Write local file – Creates a file or overwrites an existing file on your computer. Creates parent directories if needed.
• Search local files – Searches for text content in files using plain text or regular expressions (regex). Returns matching lines with file paths and line numbers.
• File info – Gets metadata about a file or directory, including size, type, permissions, modification date, and Multipurpose Internet Mail Extension (MIME) type.
• Delete local file – Deletes a file or empty directory. Moves the file to your operating system trash by default.
• Upload file – Uploads a file from your computer to Opal storage so agents can reference it in the conversation. The agent asks for your permission before uploading.
• Shell – Run a shell command on your computer and returns the output. Commands time out after 60 seconds by default.

Agents ask for your confirmation before performing destructive actions, such as writing files, deleting files, or running commands that modify your system. Read-only operations, such as reading files and running inspection commands, do not require confirmation.

Workspaces

You must grant Opal Desktop access to specific folders on your computer to let agents use the local tools. These folders are called Workspaces. Agents can only read, write, search, and run commands inside Workspaces you give access to. 

To grant access to a folder, complete the following steps:

1. Log in to Opal Desktop and click Workspaces from the left navigation bar. 

   

2. Click + Add Workspace. Select one or more folders you want to give Opal Desktop access to. You can select multiple folders at once and create folders from the dialog. 

   If you ask an agent to work with a file or folder it does not have access to, Opal Desktop grants access to the containing directory automatically. If the directory is too broad, like your home folder or file system root, Opal Desktop asks you to select a more specific folder from Workspaces instead. 

   

3. Click Done. The added folders display. 

   

4. Click Remove to revoke access to a folder. If a granted folder is moved, deleted or unmounted from your computer, Opal Desktop removes it from the list immediately. 

Add a workspace inside a conversation

To add a workspace in a conversation, click Workspaces > Add a workspace and grant Opal Desktop access to your folders. After adding them, you can view them in a drop-down list. Click a folder to add it to the top of the chat. You can only remove folders if you click Workspaces from the left navigation bar.