kastell 0.0.1 → 1.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an in-depth
+      understanding of the text from the official site at
+      http://www.apache.org/licenses/
+
+   Copyright 2026 Omer Faruk CAN
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+Kastell
+Copyright 2026 Omer Faruk CAN
+
+This product includes software developed by
+Omer Faruk CAN (https://omrfc.dev).

package/README.md

@@ -0,0 +1,283 @@
+# Kastell
+
+> Autonomous security and maintenance layer for self-hosted infrastructure.
+
+> English | [Turkce](README.tr.md)
+
+![Tests](https://github.com/omrfc/quicklify/actions/workflows/ci.yml/badge.svg)
+[![Coverage](https://codecov.io/gh/omrfc/quicklify/branch/main/graph/badge.svg)](https://codecov.io/gh/omrfc/quicklify)
+![npm](https://img.shields.io/npm/v/kastell)
+![Downloads](https://img.shields.io/npm/dt/kastell)
+![License](https://img.shields.io/badge/license-Apache%202.0-blue)
+![GitHub stars](https://img.shields.io/github/stars/omrfc/quicklify?style=flat-square)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/kastell)](https://socket.dev/npm/package/kastell)
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fkastell.dev&label=website)](https://kastell.dev)
+
+## Why Kastell Exists
+
+Most self-hosted servers break because:
+
+- No backup discipline
+- No update strategy
+- No security hardening
+- No monitoring
+- No snapshot routine
+
+Stop babysitting your servers. Kastell was built to fix that.
+
+## Quick Start
+
+```bash
+# Interactive mode -- no commands to memorize
+npx kastell
+```
+
+Running `kastell` without any arguments launches an **interactive menu** where you can browse all available actions by category, pick what you need with arrow keys, and configure options step by step -- no need to remember any command names or flags.
+
+```
+? What would you like to do?
+  Server Management
+>   Deploy a new server
+    Add an existing server
+    List all servers
+    Check server status
+    ...
+  Security
+    Harden SSH & fail2ban
+    Manage firewall (UFW)
+    ...
+```
+
+Each action includes sub-options (server mode, template, log source, port number, etc.) and a **<- Back** option to return to the main menu at any point.
+
+If you already know the commands, you can still use them directly:
+
+```bash
+kastell init                    # Deploy a new server
+kastell status my-server        # Check server status
+kastell backup --all            # Backup all servers
+```
+
+Kastell handles server provisioning, SSH key setup, firewall configuration, and platform installation automatically.
+
+## What Makes Kastell Different?
+
+| Problem | Solution |
+|---------|----------|
+| Broke your server with an update? | Pre-update snapshot protection via `maintain` |
+| No idea if your server is healthy? | Built-in monitoring, health checks, and `doctor` diagnostics |
+| Security is an afterthought? | Firewall, SSH hardening, SSL, and security audits built-in |
+| Backups? Maybe someday... | One-command backup & restore with manifest tracking |
+| Managing multiple servers? | `--all` flag across backup, maintain, status, and health |
+| Existing server not tracked? | `kastell add` brings any server under management |
+| Don't want to memorize commands? | Just run `kastell` -- interactive menu guides you |
+
+## What Can You Do?
+
+### Deploy
+```bash
+kastell                               # Interactive menu (recommended)
+kastell init                          # Interactive setup (direct)
+kastell init --provider hetzner       # Non-interactive
+kastell init --config kastell.yml     # From YAML config
+kastell init --template production    # Use a template
+kastell init --mode bare              # Generic VPS (no Coolify)
+```
+
+### Manage
+```bash
+kastell list                  # List all servers
+kastell status my-server      # Check server status
+kastell status --all          # Check all servers
+kastell ssh my-server         # SSH into server
+kastell restart my-server     # Restart server
+kastell destroy my-server     # Destroy cloud server entirely
+kastell add                   # Add existing server
+kastell remove my-server      # Remove from local config
+kastell config set key value  # Manage default configuration
+kastell export                # Export server list to JSON
+kastell import servers.json   # Import servers from JSON
+```
+
+### Update & Maintain
+```bash
+kastell update my-server      # Update Coolify (Coolify servers)
+kastell maintain my-server    # Full maintenance (snapshot + update + health + reboot)
+kastell maintain --all        # Maintain all servers
+```
+
+### Back Up & Restore
+```bash
+kastell backup my-server      # Backup DB + config
+kastell backup --all          # Backup all servers
+kastell restore my-server     # Restore from backup
+```
+
+### Snapshots
+```bash
+kastell snapshot create my-server   # Create VPS snapshot (with cost estimate)
+kastell snapshot list my-server     # List snapshots
+kastell snapshot list --all         # List all snapshots across servers
+kastell snapshot delete my-server   # Delete a snapshot
+```
+
+### Security
+```bash
+kastell firewall status my-server   # Check firewall
+kastell firewall setup my-server    # Configure UFW
+kastell secure audit my-server      # Security audit
+kastell secure setup my-server      # SSH hardening + fail2ban
+kastell domain add my-server --domain example.com  # Set domain + SSL
+```
+
+### Monitor & Debug
+```bash
+kastell monitor my-server             # CPU, RAM, disk usage
+kastell logs my-server                 # View server logs
+kastell logs my-server -f              # Follow logs
+kastell health                         # Health check all servers
+kastell doctor                         # Check local environment
+```
+
+## Supported Providers
+
+| Provider | Status | Regions | Starting Price |
+|----------|--------|---------|---------------|
+| [Hetzner Cloud](https://hetzner.cloud) | Stable | EU, US | ~EUR4/mo |
+| [DigitalOcean](https://digitalocean.com) | Stable | Global | ~$18/mo |
+| [Vultr](https://vultr.com) | Stable | Global | ~$10/mo |
+| [Linode (Akamai)](https://linode.com) | Beta | Global | ~$24/mo |
+
+> Prices reflect the default starter template per provider. You can choose a different size during setup. Linode support is in beta -- community testing welcome.
+
+## YAML Config
+
+Deploy with a single config file:
+
+```yaml
+# kastell.yml
+provider: hetzner
+region: nbg1
+size: cax11
+name: my-coolify
+fullSetup: true
+domain: coolify.example.com
+```
+
+```bash
+kastell init --config kastell.yml
+```
+
+## Templates
+
+| Template | Best For | Includes |
+|----------|----------|----------|
+| `starter` | Testing, side projects | 1-2 vCPU, 2-4 GB RAM |
+| `production` | Live applications | 2-4 vCPU, 4-8 GB RAM, full hardening |
+| `dev` | Development & CI/CD | Same as starter, no hardening |
+
+```bash
+kastell init --template production --provider hetzner
+```
+
+## Security
+
+Kastell is built with security as a priority -- **2,099 tests** across 78 suites, including dedicated security test suites.
+
+- API tokens are never stored on disk -- prompted at runtime or via environment variables
+- SSH keys are auto-generated if needed (Ed25519)
+- All SSH connections use `StrictHostKeyChecking=accept-new` with IP validation (octet range) and environment filtering
+- Shell injection protection on all user-facing inputs (`spawn`/`spawnSync`, no `execSync`)
+- Provider error messages are sanitized to prevent token leakage
+- stderr sanitization redacts IPs, home paths, tokens, and secrets from error output
+- Config file token detection (22+ key patterns, case-insensitive, nested)
+- Import/export operations strip sensitive fields and enforce strict file permissions (`0o600`)
+- `--full-setup` enables UFW firewall and SSH hardening automatically
+- MCP: SAFE_MODE (default: on) blocks all destructive operations, Zod schema validation on all inputs, path traversal protection on backup restore
+
+## Installation
+
+```bash
+# Run directly (recommended)
+npx kastell <command>
+
+# Or install globally
+npm install -g kastell
+kastell <command>
+```
+
+Requires Node.js 20 or later.
+
+## Troubleshooting
+
+**Server creation fails?**
+Run `kastell doctor --check-tokens` to verify your API token and local environment.
+
+**Server not responding?**
+Use `kastell status my-server --autostart` for Coolify servers, or `kastell health` to check all servers at once.
+
+**Need to start fresh?**
+`kastell destroy my-server` removes the cloud server entirely.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, testing, and contribution guidelines.
+
+## MCP Server (AI Integration)
+
+Kastell includes a built-in [Model Context Protocol](https://modelcontextprotocol.io/) server for AI-powered server management. Works with Claude Code, Cursor, Windsurf, and other MCP-compatible clients.
+
+```json
+{
+  "mcpServers": {
+    "kastell": {
+      "command": "npx",
+      "args": ["-y", "-p", "kastell", "kastell-mcp"],
+      "env": {
+        "HETZNER_TOKEN": "your-token",
+        "DIGITALOCEAN_TOKEN": "your-token",
+        "VULTR_TOKEN": "your-token",
+        "LINODE_TOKEN": "your-token"
+      }
+    }
+  }
+}
+```
+
+Available tools:
+
+| Tool | Actions | Description |
+|------|---------|-------------|
+| `server_info` | list, status, health | Query server information, check cloud provider & Coolify status |
+| `server_logs` | logs, monitor | Fetch Coolify/Docker logs and system metrics via SSH |
+| `server_manage` | add, remove, destroy | Register, unregister, or destroy cloud servers |
+| `server_maintain` | update, restart, maintain | Update Coolify, restart servers, run full maintenance |
+| `server_secure` | secure, firewall, domain | SSH hardening, firewall rules, domain/SSL management (10 subcommands) |
+| `server_backup` | backup, snapshot | Backup/restore databases and create/manage VPS snapshots |
+| `server_provision` | create | Provision new servers on cloud providers |
+
+> All destructive operations (destroy, restore, snapshot-delete, provision, restart, maintain, snapshot-create) require `SAFE_MODE=false` to execute.
+
+## What's Next
+
+- Scheduled maintenance (cron-based automatic upkeep)
+- Dokploy platform support (`--platform dokploy`)
+
+## Philosophy
+
+> Infrastructure should be boring, predictable, and safe.
+
+Kastell is not a script. It's your DevOps safety layer for self-hosted infrastructure.
+
+## License
+
+Apache 2.0 -- see [LICENSE](LICENSE)
+
+## Support
+
+- [GitHub Issues](https://github.com/omrfc/quicklify/issues) -- Bug reports and feature requests
+- [Changelog](CHANGELOG.md) -- Version history
+
+---
+
+Built by [@omrfc](https://github.com/omrfc)