SleekCMS Sync

Real-time bidirectional sync between VS Code and SleekCMS templates. Edit your CMS templates directly in your favorite editor with automatic synchronization.

✨ Features

🔄 Real-time bidirectional sync - Changes sync automatically between VS Code and SleekCMS
⬆️ Upload changes - Edit templates in VS Code and see changes instantly on your website
⬇️ Download changes - Changes made in SleekCMS appear in VS Code within 5 seconds
➕ Create templates - Create new template files in VS Code, automatically synced to SleekCMS
🗑️ Delete templates - Delete files from either VS Code or SleekCMS, syncs automatically
🔐 Secure authentication - Token-based authentication with optional saving
🌍 Multiple environments - Support for production, development, and localhost

📦 Installation

Open VS Code
Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X)
Search for "SleekCMS Sync"
Click Install

Or install via command:

ext install ArinJain.sleekcms-sync

🚀 Quick Start

Open a workspace folder in VS Code
Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
Run SleekCMS: Start Sync
Enter your SleekCMS API token when prompted
Select your environment (production/development/localhost)
Your templates will be downloaded and syncing will start automatically!

🔑 Getting Your API Token

Log in to your SleekCMS account at app.sleekcms.com
Navigate to Settings → API Tokens
Click "Generate New Token"
Copy the token
Paste it when VS Code prompts you

📖 Commands

Access these commands via Command Palette (Ctrl+Shift+P or Cmd+Shift+P):

Command	Description
`SleekCMS: Start Sync`	Start syncing templates with SleekCMS
`SleekCMS: Stop Sync`	Stop the sync process
`SleekCMS: Refresh Current File`	Manually refresh the current file from server
`SleekCMS: Clear Saved Token`	Clear the saved API token

⚙️ Configuration

You can configure the extension in VS Code settings:

sleekcms.token - Your SleekCMS API token
sleekcms.environment - Environment to connect to (production/development/localhost)

💡 Usage Tips

Creating New Templates

Simply create a new file in your templates folder (e.g., pages/new-page.html). The extension will automatically:

Create the template on SleekCMS
Assign it a proper ID
Start syncing it

Editing Templates

Just edit any file in VS Code. Changes are automatically uploaded to SleekCMS after 1 second of inactivity (debounced).

Deleting Templates

Delete a file from your templates folder or from SleekCMS - the deletion syncs automatically.

Real-time Updates

If someone else makes changes on SleekCMS (or you make changes in the web editor), those changes appear in VS Code within 5 seconds.

🔧 Requirements

VS Code version 1.85.0 or higher
Active SleekCMS account
Valid SleekCMS API token

🐛 Known Issues

Localhost environment requires SleekCMS to be running locally on port 9000
Development environment requires access to the staging server

📝 Release Notes

1.0.0

Initial release
Real-time bidirectional sync
Multiple environment support
Template creation and deletion
Token management

🤝 Contributing

Found a bug or have a feature request? Please open an issue on GitHub.

📄 License

MIT License - see LICENSE file for details.

🙏 Support

If you find this extension helpful, please consider:

⭐ Starring the GitHub repository
📝 Leaving a review on the VS Code Marketplace
🐛 Reporting bugs or suggesting features

Made with ❤️ by Arin Jain