Start here3 min readUpdated for Syntheo v0.4 Series

Getting started

This guide takes you from a fresh install to a reviewed first task.

Before you begin#

You need:

  • Syntheo installed;
  • access to an AI provider supported by Syntheo;
  • a project folder you can safely open;
  • a small task or question for your first run.

1. Connect an AI provider#

Open Settings → AI Provider.

Choose a provider and model for Standard, then sign in or enter the requested credential. You can configure the other model presets later.

If you already have an eligible Claude, ChatGPT, or GitHub Copilot subscription, see Connect an AI provider.

Check: Return to the main screen. If sending a message opens AI Provider settings again, the selected preset is not fully configured.

2. Add a workspace#

Choose Add Workspace in the sidebar and select one project folder.

A workspace tells Syntheo where the task belongs. Before sending anything, check that the workspace name shown near the composer is the project you intended to use.

For your first task, avoid choosing a broad parent folder that contains several unrelated projects.

3. Review tool permissions#

Open Settings → Permissions.

Keep tools that can write files, run commands, use the network, or change Git state on Ask until you are comfortable with them. When Syntheo requests approval, read the full command, path, or URL before choosing Allow Once.

Learn more in Tool permissions.

4. Ask a read-only question#

Create a new thread, choose Ask, and send:

text
Give me a short tour of this project. Tell me what it does, how I can run it,
and which three files I should read first. Do not change any files.

This checks that the provider, workspace, and read tools are working.

5. Try a small change#

Start another thread and choose Submit. If the project uses Git, turn on Virtual Edit so the result stays separate until you review it.

text
Update the empty-state message in @path/to/file so it tells the user what to do
next. Match the existing tone. Change only the relevant file and its nearest
test, then tell me what you checked.

Replace the example path with a real file. Type @ in the composer to select it.

6. Review the result#

When the task finishes:

  1. Read the summary.
  2. Open File Diff.
  3. Inspect every changed file.
  4. Check what Syntheo validated and what it did not.
  5. If you used a Virtual Edit, choose Apply Layer only when you are satisfied.

Applying a layer does not automatically commit or push it.

You are ready when#

  • a provider is connected;
  • the correct workspace is selected;
  • sensitive tools ask before running;
  • a read-only Ask task completes;
  • you can find File Diff;
  • you have reviewed one small Submit task.

Next#

Go to Everyday work to learn task modes, prompts, workspaces, and review.

← User guide · Documentation use notice