Installation
Install Synoppy CLI globally and start coding with AI.
Requirements
- Node.js 18 or newer
- npm, yarn, or pnpm
- macOS, Windows, or Linux
Install with npm
bash
npm install -g @synoppy/cliThis installs Synoppy globally, making the synoppy command available everywhere.
Or with yarn
bash
yarn global add @synoppy/cliOr with pnpm
bash
pnpm add -g @synoppy/cliVerify Installation
bash
synoppy --versionYou should see the version number printed. If you see an error, make sure your npm global bin directory is in your PATH.
Common Issues
Command not found
If you get "command not found", your npm global bin directory may not be in your PATH.
bash
npm config get prefixAdd the bin subdirectory of that path to your shell's PATH.
Permission errors on Linux/macOS
If you get EACCES errors, fix npm permissions:
bash
mkdir -p ~/.npm-global npm config set prefix '~/.npm-global' export PATH=~/.npm-global/bin:$PATHAdd the export line to your ~/.bashrc or ~/.zshrc.
Updating
To update to the latest version:
bash
npm update -g @synoppy/cliUninstalling
To remove Synoppy CLI:
bash
npm uninstall -g @synoppy/cli