Skip to main content
Config Studio is a form on the Iris Code website for choosing your project settings, so you do not have to write JSON by hand. You pick what Iris Code checks and what your code must pass, and it produces a .irisconfig.json file. Your editor, the command line and your automated checks all read that same file, so everyone works to one standard. Config Studio can send the file straight to your editor, and shows you exactly what will change before anything is written. Open Account → Config on the Iris Code website to use Config Studio.

What it covers

Every setting that counts as a shared team standard has a section, and a live preview shows the file you will get: On the Free plan, Pro sections are shown but locked. A Free config takes everything from its preset except file naming, the package guard, agent handoff and top-level refactor policy. A value typed into a locked field would be ignored by your editor, so the field cannot be edited. The preview on the right is the exact .irisconfig.json that Copy, Download and sync produce. On a narrow screen it sits below the form.
Sync replaces the settings the studio controls and keeps the rest of your file.A few settings aren’t set by the studio on purpose, because they describe one project or one machine rather than a shared standard: gateScope, ignoreFiles, ignoreFunctions, testConvention, sidebarFontSize, teamProjectId, schemaGraph, refactor.destinations, and the package guard’s allow list, which holds one repository’s reviewed exceptions. When your current file sets any of them, sync carries them over unchanged. Each still appears in its section and in search, greyed out, with why the studio leaves it alone and where to change it.They appear in the diff, and VS Code also lists them when the sync finishes.Everything else comes from the studio. A setting the studio controls but you left empty, such as a gate limit, is removed from the file.A diff is shown before anything is written. If your current file cannot be read as JSON, nothing can be carried over, and the editor asks before replacing it.

Syncing to VS Code

Sync never writes silently. Every sync first opens a diff in VS Code, a side-by-side view of your current file and the new one, so you can review the exact changes before anything is saved.
1

Open Account → Config in the browser

Navigate to iriscode.co/account/config while signed in to your Iris Code account.
2

Choose a preset or switch to Custom mode

Select a preset, or Custom to start from an empty configuration. When signed in, you can change individual settings, and the preset still supplies every value you leave alone.Saving a draft is Free. Measuring how the settings would affect your project is separate project work and may use one project action.
3

Click 'Sync to VS Code'

Click Sync to VS Code. Iris Code creates a short-lived, one-time token and opens VS Code through a deep link, a web link that opens an app directly.
4

VS Code opens a diff preview

VS Code opens and shows a diff preview of the exact changes that will be made to your .irisconfig.json.
5

Confirm or cancel

Confirm to apply the changes, or cancel to leave your config exactly as it was. Nothing is written without your confirmation.
The sync token is short-lived and single-use. If VS Code doesn’t open within a few seconds, check that the Iris Code extension is installed and that VS Code is running.

Other editors: sync with a code

The Sync to VS Code button opens a vscode:// link, which only VS Code itself responds to. JetBrains IDEs have no such link type, and VS Code forks use their own. In Trae, Positron or a JetBrains IDE, that link would open VS Code, or nothing at all. For those editors, click Get a sync code instead. You get a one-time code to paste into your editor. The rest is the same: the same diff, the same confirmation and the same write targets.
Tools → Iris Code → Sync Config from Dashboard, then paste the code.Iris Code shows a diff against your current config and writes only after you confirm. The IDE makes the change itself, so you can undo it, and analysis restarts automatically.
The code can only be redeemed once. If you cancel at the diff, generate a new code rather than reusing the old one.

Write targets

When you sync, choose where the config is written:

Workspace

Writes .irisconfig.json to the project root. Available on Free and Pro. Commit it and the whole team uses the same config automatically.

Global default

Writes your personal default configuration, so new projects on this machine start with the same settings. You need to be signed in. It still works after you have used up your monthly project actions.
In a monorepo, a repository holding several packages, sync a Workspace config to each package root that needs different thresholds. For each file, Iris Code uses the nearest .irisconfig.json in its folder or the folders above it.

Using a preset without Config Studio

You don’t need the dashboard to use a preset. Create a .irisconfig.json at your project root and add one line:
.irisconfig.json
All six preset IDs are: legacy, balanced, typescript, strict, security, ai-assisted. Commit the file and every developer on the team picks up the same thresholds automatically.

First-time setup from the CLI

iris init sets up a project from the terminal. It creates a .irisconfig.json using the Balanced preset, with comments explaining each setting, and a default AGENTS.md file of rules for coding agents. If either file already exists, it refreshes only the Iris Code sections in it. With an active Pro licence it also installs the pre-push hook. On Free, it says that step is unavailable and carries on with the rest. The command is safe to run again. It keeps an existing config and only refreshes the sections Iris Code owns in existing rules files.

Free vs Pro

Signing in turns on custom configuration for your account, so most people who can open the Studio can change every setting. An account without custom configuration works in preset-only mode.
  • Pick any preset from the selector
  • Preview the resulting JSON in the live preview panel
  • Sync to the Workspace write target
  • Configure workspace-wide fileNaming and fileNamingScope, then add ordered path rules
  • Set the package guard policy, apart from prePush
The preset values are fixed and cannot be changed locally. Editing a threshold in the generated file shows a yellow warning squiggle in the editor.