Getting StartedQuickstart

Quickstart

This guide takes you from an empty terminal to your first working session with Amara in a few minutes. You will install the syntic CLI, authenticate against api.syntic.ai, and ask Amara to make its first change.

Install the CLI

Syntic Code ships as a single command named syntic. Install it with the official script, which detects your platform and places the binary on your PATH:

curl -fsSL https://docs.syntic.ai/install.sh | sh

If you prefer a package manager, npm install -g @syntic/code works on any system with Node.js 18 or newer. Confirm the install by running syntic --version. You should see the current release printed back to you. If the command is not found, restart your shell so it picks up the updated PATH, or add the install directory manually.

Authenticate

Amara talks to the Syntic model through api.syntic.ai, so you need to sign in once. Run:

syntic login

This opens your browser to complete sign-in and stores a token locally under .syntic/. In headless or CI environments, set the SYNTIC_API_KEY environment variable instead of running the interactive login. You can check your status at any time with syntic whoami, which prints the active account and workspace.

Your first session

Change into a project directory and start Amara:

cd my-project
syntic

You will land in an interactive session. Try a concrete request such as “add a health-check endpoint and a test for it.” Amara reads the relevant files, proposes a plan, and asks before running anything that changes your system. Review each step, approve the edits you want, and iterate. When you are done, type /exit to end the session.