Quick Start
Get up and running with Synoppy CLI in under 2 minutes.
1
Install the CLI
Install Synoppy globally using npm, yarn, or pnpm.
bash
npm install -g @synoppy/cli2
Authenticate
Run the login command to authenticate via your browser.
bash
synoppy login3
Navigate to your project
Open a terminal in your project directory.
bash
cd ~/my-project4
Start Synoppy
Launch the interactive AI coding session.
bash
synoppyAuthentication Flow
When you run synoppy login:
- 1Your browser opens automatically
- 2Sign in with Google or GitHub
- 3Click "Authorize CLI" to connect
- 4Return to your terminal - you're authenticated!
Your First Session
Once authenticated, you can start chatting with Synoppy:
$ synoppy
Synoppy CLI v1.0.0
> What would you like to build today?
You: Add a dark mode toggle to the settings page
Synoppy: I'll add a dark mode toggle. Let me...
Reading src/components/Settings.tsx
Creating useTheme hook
Adding toggle component
Tips for Best Results
Be specific
Describe exactly what you want to achieve
Provide context
Mention relevant files or patterns
Ask for verification
Request tests or type checking
Use slash commands
Type /help to see all options