A lightning-fast, lightweight, and interactive CI/CD deployment tool designed to make syncing and deploying your projects effortless.
FastCICD compares your local files with your server, packages only the files that have changed (Delta Deployment), manages your Windows Services, takes automatic backups, and securely deploys your code.
Created with ❤️ by Morteza Mirshekar.
- ⚡ Delta Deployments: Why upload everything? FastCICD hashes your files locally and remotely, uploading only what has changed. This makes deployments incredibly fast.
- 🛡️ Dual-Layer Security: Protects your server using IP Whitelisting combined with time-sensitive HMAC-SHA256 signatures. No unauthorized access!
- ⚙️ Automated Service Management: Safely stops required Windows Services before deploying and restarts them automatically afterward.
- ⏪ Auto-Backups & 1-Click Rollbacks: Every deployment automatically creates a
.zipbackup of your server's current state. Broke something? Roll back instantly via the interactive menu. - 🪝 Pre & Post Deploy Hooks: Run automated CLI commands (like database migrations or npm scripts) on the server before or after your code is uploaded.
- 🎨 Beautiful Interactive UI: Powered by
Spectre.Console, the client gives you a gorgeous, menu-driven interface with live progress bars—no memorizing complex CLI arguments!
Interactive Main Menu:
Live Deployment Progress:
- Compare: The Client scans your local project folder and generates hashes for every file.
- Evaluate: It sends these hashes to the Server. The Server compares them against the live files and replies with a list of missing or modified files.
- Halt: The Client tells the Server to stop any linked Windows Services (to prevent "File in Use" errors).
- Package & Send: The Client zips only the changed files and uploads them with a live progress bar.
- Backup & Extract: The Server backs up the existing live folder, extracts the new files, and updates the version info.
- Restore: The Server restarts your Windows Services. Done!
To protect sensitive data (like your SecurityKey and local paths), this repository does not include the active appsettings.json files.
Before running the project:
- Locate the
appsettings.example.jsonfile in both the Server and Client directories. - Make a copy of it and rename the copy to
appsettings.json. - Open your new
appsettings.jsonand replace the placeholder values (e.g.,REPLACE_WITH_YOUR_LONG_SECRET_KEY) with your actual secure data.
FastCICD consists of two parts: The Server (which receives the files) and the Client (which you run on your machine to trigger the deployment).
Deploy the Server API to your hosting environment. In your server's appsettings.json, configure your security keys, directories, and allowed services:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedClientIp": "192.168.1.100", // Leave empty "" to rely solely on HMAC Dynamic Security
"SecurityKey": "YOUR_SUPER_SECRET_KEY_HERE_MAKE_IT_LONG",
"BackupDirectory": "C:\\Deployments\\Backups",
"AllowedDirectories": {
"MyAwesomeWebsite": "C:\\inetpub\\wwwroot\\MyAwesomeWebsite",
"MyWorkerService": "C:\\Services\\WorkerService"
},
"AllowedServices": [
"W3SVC",
"MyCustomWindowsService"
]
}On your local machine (or build server), place the following appsettings.json next to your Client executable.
{
"DeployerSettings": {
"ServerEndpoint": "[https://deploy.yourserver.com](https://deploy.yourserver.com)",
"SecurityKey": "YOUR_SUPER_SECRET_KEY_HERE_MAKE_IT_LONG",
"Projects": [
{
"Name": "MyAwesomeWebsite",
"LocalSourcePath": "D:\\Projects\\MyAwesomeWebsite\\bin\\Release\\net8.0\\publish",
"ServicesToManage": ["W3SVC"],
"IgnoredFiles": [
"appsettings.Development.json",
"logs/"
],
"PreDeployCommands": [
"echo 'Starting Deployment for Web'"
],
"PostDeployCommands": [
"dotnet ef database update"
]
}
]
}
}Name: Must exactly match the name defined in the Server'sAllowedDirectories.LocalSourcePath: The path on your machine where your compiled/ready-to-deploy files live.ServicesToManage: A list of Windows Services to stop before deployment and start afterward.IgnoredFiles: Files or folders you never want to upload (e.g., local dev configs).PreDeployCommands/PostDeployCommands: CLI commands to execute on the server.
Once configured, simply run the FastCICD Client console application. You will be greeted by a beautiful, interactive menu:
- Use your Arrow Keys to select a project.
- Hit Enter to view options for that project.
- Choose "🚀 Deploy (Auto Compare & Sync)" to start the magic.
- Enter your new version number (e.g.,
v1.2.0) when prompted. - Sit back and watch the live progress bar as FastCICD handles the rest!
- 📊 Check Service Status: See if your remote Windows Services are Running or Stopped.
- ℹ️ Check Current Version: See what version is currently live on the server and when it was deployed.
▶️ / ⏹️ Start/Stop Services: Manually control your remote services.- ⏪ Rollback: Instantly view previous backups and restore one if a recent deployment caused issues.
- Never share your
SecurityKey. It acts as the master password between your client and server. - The HMAC signature generates a unique cryptographic hash for every request based on the current time. This completely prevents Replay Attacks. If a request is intercepted, it will naturally expire in 5 minutes and cannot be reused.
This project is open-source, and your feedback is highly appreciated!
If you encounter any bugs, have a feature request, or just want to suggest an improvement, please feel free to open an issue.
- 🐛 Found a bug? Let me know so I can fix it!
- 💡 Have an idea? I'm always open to discussing new features.
- ⭐ Love FastCICD? Don't forget to give this repository a star to support the project!
Contributions and Pull Requests (PRs) are always welcome. Let's make deployments easier together!
FastCICD is designed and developed by Morteza Mirshekar.
This project is licensed under the MIT License - see the LICENSE file for details.