Documentation

Everything you need to get started with Synthaskill.

1. Getting Started

Windows (PowerShell):

irm https://synthaskill.com/install.ps1 | iex

macOS / Linux:

curl -fsSL https://synthaskill.com/install.sh | bash

After purchasing a license, link your device to your Synthaskill account:

synthaskill login

This opens a browser tab to authenticate via Google or GitHub and links your machine to your account.

Run Synthaskill from your project root with no arguments:

synthaskill

The interactive menu walks you through:

License check — Verifies your device is linked and your plan is active
Update check — Notifies you if a newer version is available
Project analysis — Scans languages, frameworks, build tools, and patterns
Platform selection — Choose Claude Code, Cursor, Codex, or Gemini (auto-detected)
Generation — Writes .synthaskill/ with your project intelligence, agents, and skills

Re-running synthaskill in an existing project updates the configuration without overwriting any content you’ve manually edited.

Command	Description
`synthaskill`	Interactive menu — checks license, checks for updates, analyzes project, generates or updates config
`synthaskill login`	Link this device to your Synthaskill account via browser OAuth
`synthaskill login --status`	Show current device link status and plan
`synthaskill login --logout`	Unlink this device from your account
`synthaskill update`	Check for and install the latest version of Synthaskill
`synthaskill update --check`	Check if a newer version is available without installing

All output goes to the .synthaskill/ directory in your project root:

SYNTHASKILL.md — Project intelligence document: architecture, conventions, workflows, troubleshooting (6–15 KB)
agents/ — Specialized AI agents matched to your stack, selected from 200+ library (typically 20–35 installed)
skills/ — Workflow patterns and task-specific skills, selected from 100+ library
hooks/ — Git hooks, testing hooks, build validation
settings/ — Tool preferences, permissions, model routing
references/ — Pattern files linked from skills

Pro users unlock additional agent teams: Strategy, Growth, DevRel, Architecture, Sales, Compliance, and more.

Platform	Output Location
Claude Code	`.claude/` — multi-file: `agents/`, `skills/`, `references/`
Cursor	`.cursor/rules/` — rules with Cursor YAML frontmatter
Codex	`AGENTS.md` in project root
Gemini	`.gemini/GEMINI.md` — single file, section-merge preserves your content

Issue	Solution
Node.js version error	Requires Node.js 18+. Check with `node --version`
`synthaskill: command not found`	Re-run the install script. Ensure npm global bin is in your PATH.
Login browser tab doesn’t open	Copy the URL printed in the terminal and open it manually
“Device limit reached”	Dev plan allows 10 devices. Unlink an old device in your dashboard or upgrade to Pro for unlimited devices
Files not generated	Run `synthaskill` from your project root (directory containing package.json, Cargo.toml, go.mod, etc.)
Permission denied	Run terminal as administrator (Windows) or check write permissions on the project directory