Speckle Docs

# Manager

Manager for Speckle is the best way to get (almost) all our Connectors installed and up to date on your computer, and if you have more than one Speckle accounts you'll be able to manage them there as well.

# Download

Manager is available for both Windows and Mac (with limitations). Manager automatically updates when new versions are available.

TIP

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

Download Speckle Manager now:

# 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 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": "firstlast@email.com"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Place the file:

  • on Windows, under: %appdata%\Speckle\Accounts\
  • on Mac, under: ~/.config/Speckle/Accounts
  • on Linux, under ~/.local/share/Speckle/Accounts

# Installing Connectors

🤔 Installation Problems

Having problems while 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 changing the default position, clearing your local cache, allowing beta versions etc.

# 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.

# Installing Early Versions of our Connectors

To install early version of our connectors, simply head to the versions tab inside a connector.

# Changing the default Speckle Server address

You can change the default address of the Speckle server in two ways:

  • by adding a file named server containing the server URL in %appdata%/Speckle/ (or equivalent Speckle folder in your system)
  • by adding an Environment Variable SPECKLE_SERVER containing the server URL

# Uninstalling Manager

On Windows, simply head over Apps & Features, find Manager for Speckle and then click Uninstall.

# Preventing Manager from running at Startup

On Windows, Manager will automatically launch on startup to check for new updates.

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 Manager.exe and set its Status to Disabled

# Troubleshooting

Having issues with Speckle Manager? Try the solutions below:

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

  • Open the Settings ⚙ page
  • Turn the log on
  • Try reproducing your issue and copy paste the text in the Connector log
  • 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).

← User Interface →