# Manager

Speckle Manager is a standalone desktop application you can use to keep track of your connectors, install the latest updates and handle multiple user accounts.

# Download

Manager is available for both Windows and Mac (with limitations).

TIP

Manager does not require admin privileges! Just double click and run to install it.

Download Speckle Manager now:

Manager for Windows will prompt you to update when an update is available, in Mac you'll need to manually install new versions.

# Uninstallation

On Windows, simply head over Apps & Features, find SpeckleManager and then click Uninstall.

# Preventing Manager from running at Startup

On Windows, Manager will automatically launch on startup to check for new updates. It will notify you of any updated connector versions as soon as they are released.

If you want to disable this functionality, you can simply do so:

  • Open the Task Manager, using (e.g.) Ctrl + Shift + Esc
  • Navigate to the Startup tab..
  • Find the row with SpeckleManager and set its Status to Disabled

# Logging In & Adding Accounts

NEW 🆕

You can now log into your Speckle account/s directly from our main User Interface, without the need to have Manager installed.

# From Speckle Manager

Once you have downloaded the Manager, you'll be able to easily add an account. All you need to do is head to the "Accounts" menu, click the "Add Account" button, and provide your server URL. This will open a browser window where you can log in or register an account on that server and authorise the Speckle Manager.

# From the Web

Just visit your profile and click "Add account to desktop manager":

# During Onboarding

You can also add an account directly from Speckle Web as part of the onboarding process you will see after registering on a new server.

# Adding Accounts Manually

Using Manager to handle your accounts and Connectors is the recommended way, but if you'd like to do without it a manual flow is also available.

To manually add an account you first need to generate a token for your account.

Then you can proceed to create a .json file in %appdata%\Speckle\Accounts\ with the following data structure:

{
  "token": "YOUR-TOKEN-HERE",
  "serverInfo": {
    "name": "Server Name",
    "company": "Company Name",
    "url": "https://YOUR-SERVE-URL-HERE"
  },
  "userInfo": {
    "id": "YOUR-USER-ID",
    "name": "First Last",
    "email": "[email protected]"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# Installing Connectors

Installation Problems

Having installing connectors? Check our troubleshooting section!

Manager also shows you the currently available connectors and allows you to install or remove connectors from your machine. Head into the "Connectors" menu to see what connectors you have installed and which are available to download. You'll also be able to check which version of each connector you have and update a connector as new versions are released.

# Updating Connectors

You will receive a notification in Speckle Manager when updates for your installed connectors are available. You can then update them from the Connectors page.

# Uninstalling Connectors

Just head over the Connectors page in Speckle Manager and click Remove.

# Advanced Settings

You can access the Settings page by clicking the ⚙ icon on the top right of the Speckle Manager window.

From here you'll be able to do various things such as clearing your local cache, resetting Speckle Manager, allowing beta versions etc.

# Resetting Manager

This resets the list of installed connectors but it does not uninstall them. It also does not affect any accounts.

# Resetting the local cache

The local cache is used when sending and receiving to Speckle to speed up similar operations in the future. If you notice your cache is significantly large, you can delete it from here.

# Using Beta Versions of Manager

Toggling this setting on will enable beta versions of Manager. This means that every time we make a beta release you'll be able to install it as well. If you are experiencing issues with Manager we might ask you do so to try a new version we have made.

# Using Beta Versions of our Connectors

Toggling this setting on will enable beta versions of connectors. This means that every time we make a beta release you'll be able to install it as well. In general, you should not enable this setting unless you have been asked to, this could happen when we are trying to release a fix for a specific issue affecting you.

To uninstall the beta version of a connector and to return to its latest stable release, just do the following:

  • set the beta toggle to off
  • uninstall & reinstall the connector

# SUUID

The Speckle Unique User ID is an anonimized identifier which can help us debug issues you're running into. You might be asked to share it in case you're facing bugs we cannot replicate ourselves.

# Troubleshooting

Having issues with Speckle Manager? Try the solutions below:

Cannot log into your account? Check if the Speckle server might be blocked (opens new window) Cannot see any Connectors? Check if the connectors url might be blocked (opens new window) Cannot install any Connectors? Try disabling your antivirus and/or ask IT to trust our Certificate:

Still having problems? Help us troubleshoot your issues by doing the following:

  • Open the settings page
  • Click on Open Dev Tools, a new window will open
  • Try reproducing you issue and if you see any text in the Dev Tools take a screenshot
  • Take a note of you SUUID
  • Send us a message on the forum (opens new window)!

# License

Speckle Manager is free to use and will always be. To use it you need to agree to its End User License Agreement (opens new window).

Last Updated: 3/22/2022, 12:21:20 PM