Quick Start
Quickstart Guide
Get started with Speckle Automate in just a few steps. This guide will walk you through creating your first function and automation.
Prerequisites
Before you begin, make sure you have:- A verified account on app.speckle.systems
💡 You must verify your account by responding to the email sent to you upon sign-up.
- An account on github.com
🔧 GitHub Integration: GitHub is currently the default platform for function development and deployment. We’re working on supporting additional platforms to make Automate more flexible for all users.
User Interface
As part of the public beta, Automate is now fully integrated into the main Speckle web application interface. You can access it by navigating to a project that you are the owner of:
1
Create Your First Function
- Navigate to a Workspaces-hosted project where you are a collaborator
- Go to the Automations tab and select View Functions
- Click New Function in the top right
- Follow the function creation wizard to set up your project
🧙♂️ The wizard automatically creates a GitHub repository, GitHub Actions workflow, and injects necessary environment variables.
2
Develop Your Function
- Open the Repository: View your project on GitHub.
- Open in Codespace: Start coding immediately in a virtual environment.
- Customize Your Function: Edit the template code to implement your business logic.
- Test Locally: Use the testing utilities to validate your function.
- Make a Release: Create a GitHub release to deploy your function.
3
Create Your First Automation
- Go to the Automations tab in your project
- Click New Automation
- Select your function from the library
- Configure function inputs and parameters
- Choose a Speckle model to trigger the automation
- Name your automation and click Create
4
View Results
Once your automation runs:
- Model Scene View: Look for the results “doughnut” icon in the 3D viewer
- Project Dashboard: Check the model list for automation indicators
- Results Details: Click on run cards to see detailed results and artifacts
What’s Next?
Now that you have the basics, explore:- Function Inputs - Learn how to configure user inputs
- Working with Data - Understand how to process Speckle data
- Function Testing - Set up comprehensive testing
- Creating Artefacts - Generate reports and new model versions
🚀 Pro Tip: Start with simple functions and gradually add complexity. The Automate platform is designed to be flexible and powerful.
Additional Resources
- Frequently Asked Questions - Common questions about Speckle Automate
- Important Considerations & Limitations - Important information about data handling, access, and infrastructure limitations
Need Help?
- Visit our Community Forum for support