🎉 Speckle v2 alpha is out 🚀! Check out the announcement of server and connectors.
Getting Started
Installing Speckle and getting started with the basics. • Last modified on 12/1/2020 • edit

These docs refer to Speckle v1, our team is busy working on a v2 of Speckle! Check out our blog and forum to stay updated.

1. Register

To use Speckle you'll need a Speckle server and an account on that server. If you or your company have yet to deploy your own, you can just use the "community server", hestia.

The address of hestia is:


"https://hestia.speckle.works"
Please be aware that the test server, Hestia, comes with absolutely no guarantees of any sort. While it has had stellar uptime record so far, please do not rely on it for anything remotely important!

Server sorted, you can use the always-up-to-date Speckle web app to register a new account, or you can do so also when using the clients for the first time (see below).

2. Download

To send data via Speckle, you will need to have some authoring/analysis software installed on your computer. We currently have integrations for Grasshopper, Dynamo, Rhino, GSA, Blender, Revit (beta) and Excel (beta) - either of those should do. It also helps to have a friend next to you, as it's much more fun to send data to each other rather than play ping-pong alone!

You will need to download and run the SpeckleInstaller.exe file from the link above. This will install the latest release of the clients and once it is succesful, you should be able to open the speckle plugins from the software you've installed it for.

3. Read The Docs

We've written some quick tutorials to get you started with the basic clients:

Furthermore, do read the introduction section on the right hand side. It will allow you to understand what Speckle is, how it operates, what we understand by clients, etc. It covers some basics that are useful for new starters. It will also let you know how you can ask for help if you're stuck!