quicklify 0.1.3 → 0.1.5

package/README.md

@@ -6,6 +6,7 @@
 ![Downloads](https://img.shields.io/npm/dw/quicklify)
 ![License](https://img.shields.io/badge/license-MIT-blue)
 ![GitHub stars](https://img.shields.io/github/stars/omrfc/quicklify?style=flat-square)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/quicklify)](https://socket.dev/npm/package/quicklify)
 
 > Deploy Coolify to any cloud VPS in 4 minutes
 

package/SECURITY.md

@@ -0,0 +1,39 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in Quicklify:
+
+1. **DO NOT** open a public issue
+2. Email: hello@omrfc.dev
+3. Include:
+   - Description of the vulnerability
+   - Steps to reproduce
+   - Potential impact
+   - Suggested fix (if any)
+
+Response time: Within 48 hours
+
+## Security Measures
+
+- All dependencies scanned with Socket.dev
+- No credentials stored in code
+- API tokens handled via environment variables
+- SSH keys created with secure permissions (600)
+- Input validation on all user inputs
+- Automated security checks via GitHub Actions
+
+## Third-party Dependencies
+
+Quicklify uses audited dependencies:
+- Hetzner Cloud API (official SDK)
+- All dependencies regularly updated
+- Socket.dev security monitoring enabled
+
+Security scan: https://socket.dev/npm/package/quicklify

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "quicklify",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Automate Coolify deployment on cloud providers",
   "type": "module",
   "main": "dist/index.js",
   "bin": {
     "quicklify": "dist/index.js"
   },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE",
+    "SECURITY.md"
+  ],
   "scripts": {
     "dev": "tsx src/index.ts",
     "build": "tsc && chmod +x dist/index.js",
@@ -22,6 +28,19 @@
     "cli"
   ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/omrfc/quicklify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/omrfc/quicklify/issues"
+  },
+  "homepage": "https://quicklify.omrfc.dev",
+  "author": {
+    "name": "Ömer",
+    "email": "hello@omrfc.dev",
+    "url": "https://omrfc.dev"
+  },
   "dependencies": {
     "axios": "^1.7.9",
     "chalk": "^5.4.1",

package/.github/workflows/ci.yml

@@ -1,42 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    name: Test (${{ matrix.os }}, Node ${{ matrix.node-version }})
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [18, 20, 22]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: TypeScript type check
-        run: npx tsc --noEmit
-
-      - name: Run tests
-        run: npm test
-
-      - name: Run tests with coverage
-        if: matrix.os == 'ubuntu-latest' && matrix.node-version == 22
-        run: npm run test:coverage
-
-      - name: Build
-        run: npx tsc

package/.github/workflows/publish.yml

@@ -1,25 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
-      
-      - run: npm ci
-      
-      - run: npm test
-      
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/jest.config.cjs

@@ -1,30 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  testEnvironment: 'node',
-  roots: ['<rootDir>/tests'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-    '^chalk$': '<rootDir>/tests/__mocks__/chalk.ts',
-    '^ora$': '<rootDir>/tests/__mocks__/ora.ts',
-    '^inquirer$': '<rootDir>/tests/__mocks__/inquirer.ts',
-    '^axios$': '<rootDir>/tests/__mocks__/axios.ts',
-  },
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', {
-      tsconfig: 'tsconfig.test.json',
-    }],
-  },
-  collectCoverageFrom: [
-    'src/**/*.ts',
-    '!src/index.ts',
-  ],
-  coverageDirectory: 'coverage',
-  coverageThreshold: {
-    global: {
-      branches: 80,
-      functions: 80,
-      lines: 80,
-      statements: 80,
-    },
-  },
-};

package/src/commands/init.ts

@@ -1,101 +0,0 @@
-import { HetznerProvider } from "../providers/hetzner.js";
-import { getDeploymentConfig, confirmDeployment } from "../utils/prompts.js";
-import { getCoolifyCloudInit } from "../utils/cloudInit.js";
-import { logger, createSpinner } from "../utils/logger.js";
-
-export async function initCommand() {
-  logger.title("Quicklify - Deploy Coolify in 60 seconds");
-
-  // For MVP, we only support Hetzner
-  // Later: Add provider selection prompt
-  logger.info("Using Hetzner Cloud (more providers coming soon!)");
-
-  const provider = new HetznerProvider(""); // Token will be set from config
-
-  // Get deployment configuration
-  const config = await getDeploymentConfig(provider);
-
-  // Update provider with actual token
-  const providerWithToken = new HetznerProvider(config.apiToken);
-
-  // Confirm deployment
-  const confirmed = await confirmDeployment(config, providerWithToken);
-  if (!confirmed) {
-    logger.warning("Deployment cancelled");
-    return;
-  }
-
-  try {
-    // Validate API token
-    const tokenSpinner = createSpinner("Validating API token...");
-    tokenSpinner.start();
-
-    const isValid = await providerWithToken.validateToken(config.apiToken);
-    if (!isValid) {
-      tokenSpinner.fail("Invalid API token");
-      logger.error("Please check your API token and try again");
-      return;
-    }
-    tokenSpinner.succeed("API token validated");
-
-    // Generate cloud-init script
-    const cloudInit = getCoolifyCloudInit(config.serverName);
-
-    // Create server
-    const serverSpinner = createSpinner("Creating VPS server...");
-    serverSpinner.start();
-
-    const server = await providerWithToken.createServer({
-      name: config.serverName,
-      region: config.region,
-      size: config.serverSize,
-      cloudInit,
-    });
-
-    serverSpinner.succeed(`Server created (ID: ${server.id})`);
-
-    // Wait for server to be running
-    const statusSpinner = createSpinner("Waiting for server to boot...");
-    statusSpinner.start();
-
-    let status = await providerWithToken.getServerStatus(server.id);
-    let attempts = 0;
-    const maxAttempts = 30;
-
-    while (status !== "running" && attempts < maxAttempts) {
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-      status = await providerWithToken.getServerStatus(server.id);
-      attempts++;
-    }
-
-    if (status !== "running") {
-      statusSpinner.fail("Server failed to start");
-      logger.error("Please check your cloud provider dashboard");
-      return;
-    }
-
-    statusSpinner.succeed("Server is running");
-
-    // Installing Coolify
-    const installSpinner = createSpinner("Installing Coolify (this takes 3-5 minutes)...");
-    installSpinner.start();
-
-    // Wait for Coolify installation (cloud-init runs in background)
-    await new Promise((resolve) => setTimeout(resolve, 180000));
-
-    installSpinner.succeed("Coolify installation completed");
-
-    // Success message
-    logger.title("Deployment Successful!");
-    console.log();
-    logger.success(`Server IP: ${server.ip}`);
-    logger.success(`Access Coolify: https://${server.ip}:8000`);
-    console.log();
-    logger.info("Default credentials will be shown on first login");
-    logger.info("Please wait 1-2 more minutes for Coolify to fully initialize");
-    console.log();
-  } catch (error: any) {
-    logger.error(`Deployment failed: ${error.message}`);
-    process.exit(1);
-  }
-}

package/src/index.ts

@@ -1,18 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from "commander";
-import { initCommand } from "./commands/init.js";
-
-const program = new Command();
-
-program
-  .name("quicklify")
-  .description("Automate Coolify deployment on cloud providers")
-  .version("0.1.0");
-
-program
-  .command("init")
-  .description("Deploy a new Coolify instance on a cloud provider")
-  .action(initCommand);
-
-program.parse();

package/src/providers/base.ts

@@ -1,11 +0,0 @@
-import type { Region, ServerSize, ServerConfig, ServerResult } from "../types/index.js";
-
-export interface CloudProvider {
-  name: string;
-  displayName: string;
-  validateToken(token: string): Promise<boolean>;
-  getRegions(): Region[];
-  getServerSizes(): ServerSize[];
-  createServer(config: ServerConfig): Promise<ServerResult>;
-  getServerStatus(serverId: string): Promise<string>;
-}

package/src/providers/digitalocean.ts

@@ -1,37 +0,0 @@
-import type { CloudProvider } from "./base.js";
-import type { Region, ServerSize, ServerConfig, ServerResult } from "../types/index.js";
-
-export class DigitalOceanProvider implements CloudProvider {
-  name = "digitalocean";
-  displayName = "DigitalOcean";
-  private apiToken: string;
-
-  constructor(apiToken: string) {
-    this.apiToken = apiToken;
-  }
-
-  async validateToken(_token: string): Promise<boolean> {
-    // TODO: Implement DigitalOcean API call
-    return false;
-  }
-
-  getRegions(): Region[] {
-    // TODO: Implement DigitalOcean regions
-    return [];
-  }
-
-  getServerSizes(): ServerSize[] {
-    // TODO: Implement DigitalOcean server sizes
-    return [];
-  }
-
-  async createServer(_config: ServerConfig): Promise<ServerResult> {
-    // TODO: Implement DigitalOcean API call
-    throw new Error("Not implemented");
-  }
-
-  async getServerStatus(_serverId: string): Promise<string> {
-    // TODO: Implement DigitalOcean API call
-    return "unknown";
-  }
-}

package/src/providers/hetzner.ts

@@ -1,85 +0,0 @@
-import axios from "axios";
-import type { CloudProvider } from "./base.js";
-import type { Region, ServerSize, ServerConfig, ServerResult } from "../types/index.js";
-
-export class HetznerProvider implements CloudProvider {
-  name = "hetzner";
-  displayName = "Hetzner Cloud";
-  private apiToken: string;
-  private baseUrl = "https://api.hetzner.cloud/v1";
-
-  constructor(apiToken: string) {
-    this.apiToken = apiToken;
-  }
-
-  async validateToken(token: string): Promise<boolean> {
-    try {
-      await axios.get(`${this.baseUrl}/servers`, {
-        headers: { Authorization: `Bearer ${token}` },
-      });
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  async createServer(config: ServerConfig): Promise<ServerResult> {
-    try {
-      const response = await axios.post(
-        `${this.baseUrl}/servers`,
-        {
-          name: config.name,
-          server_type: config.size,
-          location: config.region,
-          image: "ubuntu-24.04",
-          user_data: config.cloudInit,
-        },
-        {
-          headers: {
-            Authorization: `Bearer ${this.apiToken}`,
-            "Content-Type": "application/json",
-          },
-        },
-      );
-
-      return {
-        id: response.data.server.id.toString(),
-        ip: response.data.server.public_net.ipv4.ip,
-        status: response.data.server.status,
-      };
-    } catch (error: any) {
-      throw new Error(
-        `Failed to create server: ${error.response?.data?.error?.message || error.message}`,
-      );
-    }
-  }
-
-  async getServerStatus(serverId: string): Promise<string> {
-    try {
-      const response = await axios.get(`${this.baseUrl}/servers/${serverId}`, {
-        headers: { Authorization: `Bearer ${this.apiToken}` },
-      });
-      return response.data.server.status;
-    } catch (error: any) {
-      throw new Error(`Failed to get server status: ${error.message}`);
-    }
-  }
-
-  getRegions(): Region[] {
-    return [
-      { id: "nbg1", name: "Nuremberg", location: "Germany" },
-      { id: "fsn1", name: "Falkenstein", location: "Germany" },
-      { id: "hel1", name: "Helsinki", location: "Finland" },
-      { id: "ash", name: "Ashburn", location: "USA" },
-    ];
-  }
-
-  getServerSizes(): ServerSize[] {
-    return [
-      { id: "cax11", name: "CAX11", vcpu: 2, ram: 4, disk: 40, price: "€3.85/mo", recommended: true },
-      { id: "cpx11", name: "CPX11", vcpu: 2, ram: 2, disk: 40, price: "€4.15/mo" },
-      { id: "cax21", name: "CAX21", vcpu: 4, ram: 8, disk: 80, price: "€7.05/mo" },
-      { id: "cpx21", name: "CPX21", vcpu: 3, ram: 4, disk: 80, price: "€7.35/mo" },
-    ];
-  }
-}

package/src/types/index.ts

@@ -1,36 +0,0 @@
-export interface Region {
-  id: string;
-  name: string;
-  location: string;
-}
-
-export interface ServerSize {
-  id: string;
-  name: string;
-  vcpu: number;
-  ram: number;
-  disk: number;
-  price: string;
-  recommended?: boolean;
-}
-
-export interface ServerConfig {
-  name: string;
-  size: string;
-  region: string;
-  cloudInit: string;
-}
-
-export interface ServerResult {
-  id: string;
-  ip: string;
-  status: string;
-}
-
-export interface DeploymentConfig {
-  provider: string;
-  apiToken: string;
-  region: string;
-  serverSize: string;
-  serverName: string;
-}

package/src/utils/cloudInit.ts

@@ -1,29 +0,0 @@
-export function getCoolifyCloudInit(serverName: string): string {
-  return `#!/bin/bash
-set -e
-
-echo "=================================="
-echo "Quicklify Auto-Installer"
-echo "Server: ${serverName}"
-echo "=================================="
-
-# Update system
-echo "Updating system packages..."
-apt-get update -y
-
-# Install Coolify
-echo "Installing Coolify..."
-curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
-
-# Wait for services
-echo "Waiting for Coolify services to start..."
-sleep 30
-
-echo "=================================="
-echo "Coolify installation completed!"
-echo "=================================="
-echo ""
-echo "Please wait 2-3 more minutes for Coolify to fully initialize."
-echo "Then access your instance at: https://YOUR_SERVER_IP:8000"
-`;
-}

package/src/utils/logger.ts

@@ -1,37 +0,0 @@
-import chalk from "chalk";
-import ora, { type Ora } from "ora";
-
-export const logger = {
-  info: (message: string) => {
-    console.log(chalk.blue("ℹ"), message);
-  },
-
-  success: (message: string) => {
-    console.log(chalk.green("✔"), message);
-  },
-
-  error: (message: string) => {
-    console.log(chalk.red("✖"), message);
-  },
-
-  warning: (message: string) => {
-    console.log(chalk.yellow("⚠"), message);
-  },
-
-  title: (message: string) => {
-    console.log();
-    console.log(chalk.bold.cyan(message));
-    console.log();
-  },
-
-  step: (message: string) => {
-    console.log(chalk.gray("→"), message);
-  },
-};
-
-export function createSpinner(text: string): Ora {
-  return ora({
-    text,
-    color: "cyan",
-  });
-}

package/src/utils/prompts.ts

@@ -1,84 +0,0 @@
-import inquirer from "inquirer";
-import type { CloudProvider } from "../providers/base.js";
-import type { DeploymentConfig } from "../types/index.js";
-
-export async function getDeploymentConfig(provider: CloudProvider): Promise<DeploymentConfig> {
-  const answers = await inquirer.prompt([
-    {
-      type: "password",
-      name: "apiToken",
-      message: `Enter your ${provider.displayName} API token:`,
-      validate: (input: string) => {
-        if (!input || input.trim().length === 0) {
-          return "API token is required";
-        }
-        return true;
-      },
-    },
-    {
-      type: "list",
-      name: "region",
-      message: "Select region:",
-      choices: provider.getRegions().map((r) => ({
-        name: `${r.name} (${r.location})`,
-        value: r.id,
-      })),
-    },
-    {
-      type: "list",
-      name: "size",
-      message: "Select server size:",
-      choices: provider.getServerSizes().map((s) => ({
-        name: `${s.name} - ${s.vcpu} vCPU, ${s.ram}GB RAM - ${s.price}${s.recommended ? " ⭐ Recommended" : ""}`,
-        value: s.id,
-      })),
-    },
-    {
-      type: "input",
-      name: "serverName",
-      message: "Server name:",
-      default: "coolify-server",
-      validate: (input: string) => {
-        if (!input || input.trim().length === 0) {
-          return "Server name is required";
-        }
-        if (!/^[a-z0-9-]+$/.test(input)) {
-          return "Server name must contain only lowercase letters, numbers, and hyphens";
-        }
-        return true;
-      },
-    },
-  ]);
-
-  return {
-    provider: provider.name,
-    apiToken: answers.apiToken.trim(),
-    region: answers.region,
-    serverSize: answers.size,
-    serverName: answers.serverName.trim(),
-  };
-}
-
-export async function confirmDeployment(config: DeploymentConfig, provider: CloudProvider): Promise<boolean> {
-  const region = provider.getRegions().find((r) => r.id === config.region);
-  const size = provider.getServerSizes().find((s) => s.id === config.serverSize);
-
-  console.log("\nDeployment Summary:");
-  console.log(`  Provider: ${provider.displayName}`);
-  console.log(`  Region: ${region?.name} (${region?.location})`);
-  console.log(`  Size: ${size?.name} - ${size?.vcpu} vCPU, ${size?.ram}GB RAM`);
-  console.log(`  Price: ${size?.price}`);
-  console.log(`  Server Name: ${config.serverName}`);
-  console.log();
-
-  const { confirm } = await inquirer.prompt([
-    {
-      type: "confirm",
-      name: "confirm",
-      message: "Proceed with deployment?",
-      default: true,
-    },
-  ]);
-
-  return confirm;
-}

package/tests/__mocks__/axios.ts

@@ -1,14 +0,0 @@
-const axios = {
-  get: jest.fn(),
-  post: jest.fn(),
-  put: jest.fn(),
-  delete: jest.fn(),
-  patch: jest.fn(),
-  defaults: {
-    headers: {
-      common: {},
-    },
-  },
-};
-
-export default axios;

package/tests/__mocks__/chalk.ts

@@ -1,15 +0,0 @@
-const identity = (s: string) => s;
-
-const bold = Object.assign(identity, { cyan: identity });
-
-const chalk = {
-  blue: identity,
-  green: identity,
-  red: identity,
-  yellow: identity,
-  gray: identity,
-  cyan: identity,
-  bold,
-};
-
-export default chalk;

package/tests/__mocks__/inquirer.ts

@@ -1,5 +0,0 @@
-const inquirer = {
-  prompt: jest.fn(),
-};
-
-export default inquirer;

package/tests/__mocks__/ora.ts

@@ -1,16 +0,0 @@
-const createMockSpinner = () => {
-  const spinner: any = {
-    text: '',
-    color: 'cyan',
-  };
-  spinner.start = jest.fn(() => spinner);
-  spinner.succeed = jest.fn(() => spinner);
-  spinner.fail = jest.fn(() => spinner);
-  spinner.stop = jest.fn(() => spinner);
-  return spinner;
-};
-
-const ora = jest.fn(() => createMockSpinner());
-
-export default ora;
-export { createMockSpinner };