Installation

Installing Syntaxis just copies workflow files into your project from an npm package — it introduces no runtime dependency and leaves your application’s own source code completely alone.

Install

# npm
npx create-syntaxis@latest

# pnpm
pnpm dlx create-syntaxis@latest

To create the application at the same time, in an empty directory:

npx create-syntaxis@latest --scaffold

Options

Option	Effect
--scaffold	Create the application first. Needs an empty directory.
--stack <name>	Stack to scaffold; implies --scaffold. Omit to choose interactively.
--codex	Install the Codex adapter
--claude	Install the Claude Code adapter
--copilot	Install the GitHub Copilot adapter
--opencode	Install the OpenCode adapter
--all	Install every adapter. Do not combine with individual flags.
--target, -t	Target directory, defaults to the current one
--dry-run	Print what would be copied without writing anything
--force, -f	Overwrite matching files
--yes, -y	Use defaults in a non-interactive install

Skip the adapter flags in an interactive terminal and you’ll get the picker instead.

What gets installed

Path	Purpose
AGENTS.md	Cross-tool entry point every agent reads
CLAUDE.md	Claude Code entry point; imports AGENTS.md
.agents/skills/	Skills for Codex, Copilot, and OpenCode
.claude/skills/	Skills for Claude Code
syntaxis/	Plans, generated context, QA artifacts, and history

Your README.md stays exactly as it was.

Adapters

Choose as many as you actually use. Tool Adapters has the full detail.

Tool	Adapter	Invocation
Claude Code	.claude/skills/	/feature, /implement
Codex	.agents/skills/	$feature, $implement
GitHub Copilot	AGENTS.md + .agents/skills/	Ask it to run the skill
OpenCode	AGENTS.md + a compatible tree	Ask it to run the skill

Codex, Copilot, and OpenCode all share one .agents/ tree. OpenCode is equally happy reusing .claude/ when Claude Code is also selected, which is why the installer never writes a third, duplicate copy under .opencode/skills/.

Confirm it actually worked

npx create-syntaxis@latest status

Or ask your AI chat to run /doctor for a deeper health check across setup, adapters, plans, and workflow state.

Optional global command

npm install --global create-syntaxis@latest
syntaxis status
syntaxis dashboard

The global syntaxis command only ever does project status and the local dashboard — installing and updating still go through npx create-syntaxis@latest.

See the plan before committing to it

npx create-syntaxis@latest --dry-run

This prints the adapters and the exact files involved without writing a single one of them.