Get started with Syntic Code
Syntic Code is Syntic’s coding agent for your terminal: you run the syntic command in a project folder, describe a job, and it reads code, edits files and runs commands with your approval. To start you need a paid Syntic plan and a supported computer.
Syntic Code has no public download yet. Install instructions are coming soon at code.syntic.ai/docs/cli/install. The steps below describe the first run once you have it.
Before you begin
| You need | Details |
|---|---|
| A paid Syntic plan | Starter or higher. Free accounts are refused. See Use Syntic Code with your individual plan. |
| macOS, Linux or Windows | Apple silicon and Intel Macs; x86-64 and ARM64 Linux; x64 and ARM64 Windows. |
| A project folder | A git repository is best, so you can review and undo changes with your usual tools. |
You do not need an API key for everyday use. You sign in with your Syntic account in the browser.
First run
Install
See Install Syntic Code for the current install status.
Open your project
cd ~/code/my-project
synticAnswer the first-run screens
The first start asks for a color theme, signs you in through the browser, shows a short safety note, and asks which key you want for new lines. See Sign in to Syntic Code if the browser step needs help.
Decide whether to trust the folder
The first time you start in a folder, Syntic Code asks whether you trust it. Only say yes for code you know; a project’s own settings are ignored until you do.
Check your setup
Your plan name appears on the Plan: line at the top of the session. From your shell, syntic doctor reports where files are kept, whether settings are valid, and whether you are signed in.
Where Syntic Code is available
| Surface | Status |
|---|---|
Terminal (the syntic command) | Coming soon (public download not published yet) |
Scripts and CI (syntic -p) | Comes with the terminal app. See API keys and environment variables. |
| In your code editor | Run syntic in the editor’s built-in terminal. Dedicated editor extensions are not available yet. |
| On the web | Not available yet. See Syntic Code on the web. |
| Desktop app | Preview only. See Syntic Desktop. |
Syntic Code asks before risky actions, cannot edit a file it has not read in the current session, and keeps backups of its edits so you can roll back. How these controls work is covered in the docs.