Thanks for visiting our user guide! This is the single source of documentation on everything Speckle.
Organizations all over the world rely on our collaboration, interoperability and automation platform to deliver better buildings, faster. Speckle is a platform with endless possibilities, we'll walk you through some of its most common usage scenarios, but ultimately you'll have the flexibility to use Speckle (and your data) however you want.
# What We'll Cover
This guide provides an introduction to the key Speckle concepts you'll need to know. We'll go over what you need to install, how to create an account, and how to send data to your first Speckle stream.
Towards the end of this guide, there are a few tutorials which provide step-by-step guidance for several common workflows (e.g. sending data Rhino -> Revit and back).
If you're a programmer wanting to learn how to build things with Speckle, head over to our developer docs. If you're after some in-depth reading on how Speckle works under the hood, make sure to check the core concepts section.
This guide assumes you have access to a Speckle Server. If you don't have one provided by your company, you can use our free Speckle server (opens new window).
# Our Tech
Speckle is made up of several moving parts. Before describing each in detail, let's run through them quickly.
# Speckle Web App
The Speckle Web App lets you manage and coordinate your data directly from your web browser. It includes a management interface to help you administer your various streams and a 3D model viewer to let see your projects.
Our desktop Connectors are plugins for some of the most popular construction industry software including Rhino, Revit, Grasshopper, Dynamo, AutoCAD, Civil3D, Unity, Blender (and more). They take care of sending and receiving data in your software (e.g. Rhino) to and from your Speckle server. The Connectors can handle almost any kind of data. Most commonly, this will be CAD and BIM data; essentially, geometry with attached metadata.
Each time the Connectors send data to your Speckle server, they also take care of transforming it from your software's native format to Speckle's own, neutral format. This makes accessing it from other software extremely easy and fast.
# Speckle Manager
The Speckle Manager is a desktop application that handles accounts and connectors on your machine. You'll need to add a Speckle account to your computer using Speckle Manager in order to be authorised to send or access data to/from a Speckle Server.
# Legal stuff