Install Syntax Code and get started.

Install on Windows

One zip file contains the command line tool, the VS Code extension, the Excel add-in and an installer. It copies syntax-code.exe to %USERPROFILE%\.local\bin and adds that folder to your PATH.

1. 1
   Download syntax-code-windows.zip.

   From the Syntax Code folder on SharePoint (button above). Sign in with your Syntax account if asked.

2. 2
   Right-click the zip → Extract All.

   Extract first. Do not start the installer from inside the zip.

3. 3
   Right-click install.ps1 → Run with PowerShell.

   The script is in the folder syntax-code-windows inside the extracted folder. No admin rights needed; Windows asks once to confirm a local certificate for the Excel add-in. If VS Code is installed, the extension is installed with it.

4. 4
   Open a new terminal and run syntax-code.

   It must be a new window, so the changed PATH is picked up. The first start reports that the API key is missing and names the settings file.

5. 5
   Put your API key into the settings file.

   In PowerShell, run notepad $HOME\.syntax-code\config.toml. Change the line # api_key = "sk-...": remove the #, put your key between the quotes, save. How to create the key.

6. 6
   Run syntax-code again.

   The welcome screen appears. Start it in the folder of the project you want to work on.

Remove: delete %USERPROFILE%\.local\bin\syntax-code.exe and uninstall the extension SyntaxCode in VS Code. Your API key is in the folder .syntax-code in your home folder; delete that too.

Install on macOS

One zip file contains the command line tool for Apple silicon and Intel, the VS Code extension, the Excel add-in and an install script. It copies syntax-code to ~/.local/bin.

1. 1
   Download syntax-code-macos.zip.

   From the Syntax Code folder on SharePoint (button above). Sign in with your Syntax account if asked.

2. 2
   Double-click the zip in Downloads.

   Finder unpacks it into the folder syntax-code-macos.

3. 3
   Open Terminal.

   ⌘ + Space, type “Terminal”, Enter.

4. 4
   Run the install script.

   cd ~/Downloads/syntax-code-macos && bash install.sh
   Please run it in Terminal, not by double-click: macOS blocks downloaded scripts. No admin password is needed; macOS may ask for your login password to trust a local certificate for the Excel add-in.

5. 5
   Open a new Terminal window and run syntax-code.

   The first start reports that the API key is missing and names the settings file.

6. 6
   Put your API key into the settings file.

   Run open -e ~/.syntax-code/config.toml. Change the line # api_key = "sk-...": remove the #, put your key between the quotes, save. How to create the key.

7. 7
   Run syntax-code again.

   The welcome screen appears. Start it in the folder of the project you want to work on.

Remove: delete ~/.local/bin/syntax-code and uninstall the extension SyntaxCode in VS Code. Your API key is in the folder .syntax-code in your home folder; delete that too.

Create your GenAI Studio API key

Syntax Code talks to GenAI Studio on your behalf, with your own personal key. The key is stored in the settings file on your machine.

1. 1
   Log in to GenAI Studio.

   With your company account.

2. 2
   Open the user menu → API Keys.

   The user menu is at the top right.

3. 3
   Click Create new secret key.
4. 4
   Give it a descriptive name.

   For example “Syntax Code”.

5. 5
   Copy the key and store it securely.

   It is shown only once. Put it into config.toml as described in the install steps.

VS Code: first steps

The installer adds the extension SyntaxCode to VS Code. It brings its own copy of the command line tool and uses the same API key.

1. 1
   Open the chat.

   Click the octopus icon in the Activity Bar or press Ctrl+Shift+Y (macOS: ⌘⇧Y). After installing, reload VS Code once: Developer: Reload Window.

2. 2
   Ask in plain language.

   The agent is told which file is open; your selection and the file’s error messages are sent along. Every file read and every command appears as a card. To stop a request, click the send button, which turns into a stop button, or type /cancel.

3. 3
   Confirm each change yourself, if you like.

   In the settings, set syntaxCode.permissionMode to interactive, then reload VS Code (Developer: Reload Window); the setting is read at start. Each edit then shows its changed lines and waits for Apply or Reject; a card that gets no answer within 60 seconds is rejected. The default auto applies changes without asking.

4. 4
   Ask about a piece of code.

   Select it, right-click, Send Selection to Chat: the selection is placed in the message box. Add to Syntax Code Chat, in the same menu and in the Explorer, attaches the whole file.