Quick Start Guide

Step 1: Choose how to get started

There are three ways to begin designing in Circuitly:

Create a workspace with a new project

From Home, select Start from scratch.
A modal will appear to name your workspace.

A new workspace automatically includes an untitled project folder where you can add more projects. Each project folder contains one schematic and board document. All projects in Circuitly are linked to a specific KiCad version. The default KiCad version is V9 and can be changed in the project settings.

Import an existing KiCad project

From Home select Upload from your computer.
Drag and drop the files or upload from your file browser.
Add a workspace name and select create workspace.

Clone a git repository

From Home, select Clone a git repository.
In the modal, search GitHub or GitLab directly, or paste a Git URL. Be sure to authorize access if you’re using GitHub or GitLab.
When you select a repository, a new workspace will be created and opened as a clone of the Git repository.

Step 2: Import or create a library

When you import an existing project from your computer or a Git repository, its libraries will automatically appear in the Libraries Panel. If you are starting a new workspace, you can either import an existing library or create a new one.

Import existing libraries

In the Workspace, navigate to the Sidebar on the left.
Click the Library Icon to display the Library Panel in the Top Left Panel.
Under Libraries, select +.
Select Import Libraries. Drag and drop the library file or upload it from your file browser.

Create a new library

In the Library Panel, select + next to Project Libraries and select Create New Library.
Enter a new library name and select Create.
The new library will appear in the Library Panel.

Import individual footprints into a library

Currently, you can import individual footprints into a library, but not individual symbols. To do so, simply drag and drop the footprint into your chosen library.

Step 3: Design

Add symbols to the schematic

To add symbols to the schematic, drag and drop existing symbols from the Symbol Library in the Library Panel.

Manage symbols

Manage symbols by creating new ones or editing existing ones.

To create a new symbol:

Choose a desired library from the Symbol Library.
Click + or right click and choose Create New Symbol.
Fill in the required fields and click Create.

You can edit symbols in a library, or make local edits within the schematic editor for that specific project.

To edit a symbol library:

Navigate to the Symbol Library in the Library Panel.
Right click the desired symbol and select Edit.

Right click the desired symbol in the schematic.
Choose Edit Symbol in Library.

To edit symbols in the schematic:

Right click the desired symbol in the schematic.
Choose Edit Symbol in Schematic.

Connect components

From the Toolbar, select the Wire Tool.
Click on a pin of a symbol to start the wire.
Move your cursor to the pin of another symbol and click to complete the connection.

Assign footprints

There are two ways to assign footprints.

From the symbol:

Right-click anywhere on the canvas.
Click Assign Footprint to open Footprint Library.
Select the desired footprint and click OK.

From the Library Panel:

In the Library Panel on the left, open the Footprint Library.
With the symbol selected, drag and drop the appropriate footprint into the Footprint Field in the Properties Panel on the right.

Update board from schematic

Once your schematic is complete and you’re ready to start on the PCB Layout:

In the top Menu Bar, open the Tools drop-down menu.
Select Update Board from Schematic, or use the shortcut Cmd + U on Mac and Ctrl + U on Windows.

Place and move footprints

After updating the board, the footprints will appear in the upper left corner of the board. Use the Selection Tool to place them as needed.

Edit footprints

Like editing symbols, you can edit footprints in a library or make local edits within the board editor for that specific project.

To edit footprints at the global level:

In the Library Panel on the left, open the Footprint Library.
Right click the desired footprint and select Edit.

Right click the desired footprint in the board.
Choose Edit Library Footprint.

To edit footprints at the board level:

Right click the desired footprint in the board.
Choose Edit Footprint in Board.

Route tracks

To view airwires, go to the top Menu Bar, open the View menu, and select Show Airwires.
To start connecting pads, select the Interactive Route Tool from the Tool Bar.
Click on a pad, then drag to connect it to another pad.

Get help from AI Research Assistant

The AI Research Assistant must be enabled by the owner of each workspace and is disabled by default.

To enable AI Research Assistant:

From the Sidebar on the left, click the AI Research Assistant button.
A modal will open where you can enable the AI Research Assistant for your current workspace.
The AI Research Assistant Panel will appear in the Right Panel.

To disable AI Research Assistant:

Go to the AI Research Assistant Panel in the Right Panel.
Click the three-dot icon at the bottom of the chat box.
From the menu, select Disable Research Assistant.

Step 4: Collaborate & share

Invite collaborators and share work online

From Home select (…) at the bottom right of any workspace and click Share Workspace.
The Share menu will open where you can:
- Invite someone to the workspace.
- See people with access as well as their level of permissions.
- Copy the URL to share with others or post online.

Comment

Comments can be added anywhere in the schematic or board.

From the Toolbar in either the schematic or board editor select Add comment.
Your cursor will change to a crosshair with your initials. Click anywhere to place your comment.
When Add comments has been selected, the panel on the right will switch to the Comments Panel, where you can view all comments.