5-Minute Quickstart
Connect to your Repository and Execute on Tasks in just 5 Minutes
In this Quickstart Guide, you’ll use Factory to Q&A your codebase, create a feature, and save it down to your local files.
Make sure you have access to Factory before getting started.
Step 1: Open Factory and Create a Session
Launch Factory
Open the Factory application in your browser.
Select Your Droid
Select the appropriate Droid based on your project needs.
Note, that each Droid is provisioned highly specific system prompts and tools that make them particularly adept at certain tasks.
Choose your Model and Tools
Select your desired Model and activate the necessary Tools for your task.
Tools extend the functionality of the Factory Droids beyond the Factory platform. The Github tool, for example, creates a bi-directional integration with Github/Gitlab while our Project Management tool does the same with Jira/Linear.
See our Integrations guide to connect your Github/Gitlab and Jira/Linear.
Step 2: Connect to Your Local Machine
Add a Local Repo
Click on Select Repo and select + Add Local Repo
Connect to Local Machine
Factory Bridge creates a secure connection between the Factory platform and your local machine, enabling powerful capabilities like running CLI commands, managing local processes, and accessing local resources directly from your Factory sessions.
See our Integrations guide to connect your Github/Gitlab.
Download Factory Bridge
Download the Factory Bridge and move the Bridge to the Applications folder. Then, set your Root Directory.
Connect to the Factory Bridge
Enter the pairing code in the Bridge app to connect.
Add your Local Repo
Return to the Factory platform and select a Local Repo to add to your session.
Local repositories may take a few minutes to index.
Step 3: Codebase Q&A
Ask Factory Any Question
Ask anything about your Codebase and referencing any relevant repositories or context using the ”@”. You can tag any remote/local repository, file, pull request, ticket, notion doc, or Google Doc for consideration.
Learn more about Context Retrieval
Clarification and Response
View Factory’s Response. The Factory Droid may return with clarification questions to ensure it understand exactly how you would like the Droid to execute on the task.
Step 4: Execution
Request Factory to Generate Code
Factory will generate the code for the requested feature. Factory will launch a new session with the prompt and included context.
View and Save Files
Leverage Factory’s Auto-Save feature to immediately save all files down to the appropriate location in your local directories. You can also enable Auto-Accept for CLI commands and Tool Use to provide a truly autonomous experience.
Congratulations! 🎉
You’ve just built a UI component using Factory. This is just the beginning of what you can do with Factory.
Next Steps
- Explore more Context Management features
- Learn about Workflows
- Check out our Use Cases