@dokploy/cli 0.2.8 → 0.3.1

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { run } from '@oclif/core';
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -1 +1,24 @@
-export { run } from '@oclif/core';
+#!/usr/bin/env node
+import chalk from "chalk";
+import { program } from "commander";
+import { registerAuthCommand } from "./commands/auth.js";
+import { registerGeneratedCommands } from "./generated/commands.js";
+const pkg = {
+    name: "dokploy",
+    version: "0.3.0",
+    description: "Dokploy CLI - Manage your Dokploy server",
+};
+program
+    .name(pkg.name)
+    .version(pkg.version)
+    .description(pkg.description)
+    .action(() => {
+    program.help();
+});
+registerAuthCommand(program);
+registerGeneratedCommands(program);
+const argv = process.argv.filter((arg) => arg !== "--");
+program.parseAsync(argv).catch((err) => {
+    console.error(chalk.red(err.message));
+    process.exit(1);
+});

package/package.json

@@ -1,88 +1,55 @@
 {
   "name": "@dokploy/cli",
   "description": "A CLI to manage dokploy server remotely",
-  "version": "v0.2.8",
+  "version": "0.3.1",
   "author": "Mauricio Siu",
-  "licenses": [{
-    "type": "MIT",
-    "url": "https://github.com/Dokploy/cli/blob/master/LICENSE"
-  }],
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/Dokploy/cli/blob/master/LICENSE"
+    }
+  ],
   "publishConfig": {
     "access": "public"
   },
   "bin": {
-    "dokploy": "./bin/run.js"
+    "dokploy": "./dist/index.js"
   },
   "bugs": "https://github.com/Dokploy/cli/issues",
   "dependencies": {
-    "@oclif/core": "^3",
-    "@oclif/plugin-help": "^6",
-    "@oclif/plugin-plugins": "^5",
     "axios": "^1.7.2",
     "chalk": "^5.3.0",
-    "cli-table3": "^0.6.5",
-    "inquirer": "^9.2.23",
-    "slugify": "^1.6.6",
-    "superjson": "^2.2.1"
+    "commander": "^13.1.0"
   },
   "devDependencies": {
-    "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^4",
-    "@types/chai": "^4",
-    "@types/inquirer": "9.0.7",
-    "@types/mocha": "^10",
+    "@biomejs/biome": "2.1.1",
     "@types/node": "^18",
-    "chai": "^4",
-    "eslint": "^8",
-    "eslint-config-oclif": "^5",
-    "eslint-config-oclif-typescript": "^3",
-    "eslint-config-prettier": "^9",
-    "mocha": "^10",
-    "oclif": "^4",
-    "shx": "^0.3.3",
-    "ts-node": "^10",
-    "typescript": "^5"
+    "tsx": "^4.21.0",
+    "typescript": "^5",
+    "vitest": "^4.1.4"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "files": [
-    "/bin",
-    "/dist",
-    "/oclif.manifest.json"
+    "/dist"
   ],
   "homepage": "https://github.com/Dokploy/cli",
   "keywords": [
-    "oclif"
+    "dokploy",
+    "cli"
   ],
   "license": "MIT",
   "main": "dist/index.js",
   "type": "module",
-  "oclif": {
-    "bin": "dokploy",
-    "dirname": "dokploy",
-    "commands": "./dist/commands",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins"
-    ],
-    "topicSeparator": " ",
-    "topics": {
-      "hello": {
-        "description": "Say hello to the world and others"
-      }
-    }
-  },
   "repository": "Dokploy/cli",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "build": "shx rm -rf dist && tsc -b",
-    "lint": "eslint . --ext .ts",
-    "postpack": "shx rm -f oclif.manifest.json",
-    "posttest": "pnpm run lint",
-    "prepack": "oclif manifest && oclif readme",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md",
-    "publish" :"npm publish"
-  },
-  "types": "dist/index.d.ts"
-}
+    "build": "tsc -b",
+    "generate": "tsx scripts/generate.ts",
+    "prebuild": "pnpm run generate",
+    "dev": "tsx src/index.ts",
+    "lint": "biome check --write .",
+    "test": "vitest run"
+  }
+}

package/readme.md

@@ -1,118 +1,136 @@
 # Dokploy CLI
 
-<!-- ![Dokploy Logo](https://via.placeholder.com/150x150.png?text=Dokploy+CLI) -->
-
-Dokploy CLI is a powerful and versatile command-line tool designed to remotely manage your Dokploy server. It simplifies the process of creating, deploying, and managing applications and databases.
-
-<!-- [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/dokploy.svg)](https://npmjs.org/package/dokploy)
-[![Downloads/week](https://img.shields.io/npm/dw/dokploy.svg)](https://npmjs.org/package/dokploy)
-[![License](https://img.shields.io/npm/l/dokploy.svg)](https://github.com/yourusername/dokploy/blob/master/package.json) -->
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Usage](#usage)
-- [Commands](#commands)
-  - [Authentication](#authentication)
-  - [Project Management](#project-management)
-  - [Application Management](#application-management)
-  - [Environment Management](#environment-management)
-  - [Database Management](#database-management)
-- [Contributing](#contributing)
-- [Support](#support)
-- [License](#license)
+Dokploy CLI is a command-line tool to manage your Dokploy server remotely. It provides **449 commands** auto-generated from the Dokploy OpenAPI spec, covering every API endpoint.
 
 ## Installation
 
-```sh-session
-$ npm install -g @dokploy/cli
+```bash
+npm install -g @dokploy/cli
 ```
 
-## Usage
-
-```sh-session
-$ dokploy COMMAND
-running command...
+## Authentication
 
-$ dokploy --version
-dokploy/0.0.0 darwin-arm64 node-v18.18.0
+### Option 1: Using the `auth` command
 
-$ dokploy --help [COMMAND]
-USAGE
-  $ dokploy COMMAND
-...
+```bash
+dokploy auth -u https://panel.dokploy.com -t YOUR_API_KEY
 ```
 
-## Commands
+### Option 2: Environment variables
 
-### Authentication
+```bash
+export DOKPLOY_URL="https://panel.dokploy.com"
+export DOKPLOY_API_KEY="YOUR_API_KEY"
+```
 
-- `dokploy authenticate`: Authenticate with the Dokploy server.
-- `dokploy verify`: Verify current authentication.
+### Option 3: `.env` file
 
-### Project Management
+Create a `.env` file in your working directory:
 
-- `dokploy project:create`: Create a new project.
-- `dokploy project:info`: Get information about an existing project.
-- `dokploy project:list`: List all projects.
+```env
+DOKPLOY_URL="https://panel.dokploy.com"
+DOKPLOY_API_KEY="YOUR_API_KEY"
+```
 
-### Application Management
+The CLI loads it automatically. Shell environment variables take priority over the `.env` file.
 
-- `dokploy app:create`: Create a new application.
-- `dokploy app:delete`: Delete an existing application.
-- `dokploy app:deploy`: Deploy an application.
-- `dokploy app:stop`: Stop a running application.
+## Usage
 
-### Enviroment Management
+```bash
+dokploy <group> <action> [options]
+```
 
-- `dokploy env pull <file>`: Pull environment variables from Dokploy in a <file>.
-- `dokploy env push <file>`: Push environment variables to Dokploy from a <file>.
+### Examples
 
-### Database Management
+```bash
+# List all projects
+dokploy project all
 
-Dokploy supports various types of databases:
+# Get a specific project
+dokploy project one --projectId abc123
 
-#### MariaDB
+# Create an application
+dokploy application create --name "my-app" --environmentId env123
 
-- `dokploy database:mariadb:create`
-- `dokploy database:mariadb:delete`
-- `dokploy database:mariadb:deploy`
-- `dokploy database:mariadb:stop`
+# Deploy an application
+dokploy application deploy --applicationId app123
 
-#### MongoDB
+# Create a postgres database
+dokploy postgres create --name "my-db" --environmentId env123
 
-- `dokploy database:mongo:create`
-- `dokploy database:mongo:delete`
-- `dokploy database:mongo:deploy`
-- `dokploy database:mongo:stop`
+# Stop a database
+dokploy postgres stop --postgresId pg123
 
-#### MySQL
+# Get raw JSON output
+dokploy project all --json
+```
 
-- `dokploy database:mysql:create`
-- `dokploy database:mysql:delete`
-- `dokploy database:mysql:deploy`
-- `dokploy database:mysql:stop`
+### Getting help
 
-#### PostgreSQL
+```bash
+# List all groups
+dokploy --help
 
-- `dokploy database:postgres:create`
-- `dokploy database:postgres:delete`
-- `dokploy database:postgres:deploy`
-- `dokploy database:postgres:stop`
+# List actions in a group
+dokploy application --help
 
-#### Redis
+# See options for a specific action
+dokploy application deploy --help
+```
 
-- `dokploy database:redis:create`
-- `dokploy database:redis:delete`
-- `dokploy database:redis:deploy`
-- `dokploy database:redis:stop`
+## Available command groups
+
+| Group | Commands | Group | Commands |
+|---|---|---|---|
+| `admin` | 1 | `notification` | 38 |
+| `ai` | 9 | `organization` | 10 |
+| `application` | 29 | `patch` | 12 |
+| `backup` | 11 | `port` | 4 |
+| `bitbucket` | 7 | `postgres` | 14 |
+| `certificates` | 4 | `preview-deployment` | 4 |
+| `cluster` | 4 | `project` | 8 |
+| `compose` | 28 | `redirects` | 4 |
+| `deployment` | 8 | `redis` | 14 |
+| `destination` | 6 | `registry` | 7 |
+| `docker` | 7 | `rollback` | 2 |
+| `domain` | 9 | `schedule` | 6 |
+| `environment` | 7 | `security` | 4 |
+| `gitea` | 8 | `server` | 16 |
+| `github` | 6 | `settings` | 49 |
+| `gitlab` | 7 | `ssh-key` | 6 |
+| `git-provider` | 2 | `sso` | 10 |
+| `license-key` | 6 | `stripe` | 7 |
+| `mariadb` | 14 | `swarm` | 3 |
+| `mongo` | 14 | `user` | 18 |
+| `mounts` | 6 | `volume-backups` | 6 |
+| `mysql` | 14 | | |
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Run in dev mode
+pnpm run dev -- project all
+
+# Regenerate commands from OpenAPI spec
+pnpm run generate
+
+# Build
+pnpm run build
+
+# Lint & format
+pnpm run lint
+```
 
-For more information about a specific command, use:
+### Updating commands
 
-```sh-session
-$ dokploy [COMMAND] --help
-```
+Commands are auto-generated from `openapi.json`. To update:
+
+1. Replace `openapi.json` with the latest spec from the [Dokploy repo](https://github.com/Dokploy/dokploy)
+2. Run `pnpm run generate`
+3. Build with `pnpm run build`
 
 ## Contributing
 
@@ -120,7 +138,7 @@ If you want to contribute to Dokploy CLI, please check out our [Contributing Gui
 
 ## Support
 
-If you encounter any issues or have any questions, please [open an issue](https://github.com/yourusername/dokploy/issues) in our GitHub repository.
+If you encounter any issues or have any questions, please [open an issue](https://github.com/Dokploy/cli/issues) in our GitHub repository.
 
 ## License
 

package/bin/dev.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -1,6 +0,0 @@
-#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
-
-// eslint-disable-next-line n/shebang
-import {execute} from '@oclif/core'
-
-await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*

package/bin/run.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-import {execute} from '@oclif/core'
-
-await execute({dir: import.meta.url})

package/dist/commands/app/create.d.ts

@@ -1,17 +0,0 @@
-import { Command } from "@oclif/core";
-import { type Project } from "../../utils/shared.js";
-export interface Answers {
-    project: Project;
-}
-export default class AppCreate extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        projectId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        name: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        description: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        appName: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        skipConfirm: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/app/create.js

@@ -1,127 +0,0 @@
-import { Command, Flags } from "@oclif/core";
-import axios from "axios";
-import chalk from "chalk";
-import inquirer from "inquirer";
-import { getProjects } from "../../utils/shared.js";
-import { slugify } from "../../utils/slug.js";
-import { readAuthConfig } from "../../utils/utils.js";
-export default class AppCreate extends Command {
-    static description = "Create a new application within a project.";
-    static examples = ["$ <%= config.bin %> app create"];
-    static flags = {
-        projectId: Flags.string({
-            char: "p",
-            description: "ID of the project",
-            required: false,
-        }),
-        name: Flags.string({
-            char: "n",
-            description: "Application name",
-            required: false,
-        }),
-        description: Flags.string({
-            char: "d",
-            description: "Application description",
-            required: false,
-        }),
-        appName: Flags.string({
-            description: "Docker app name",
-            required: false,
-        }),
-        skipConfirm: Flags.boolean({
-            char: "y",
-            description: "Skip confirmation prompt",
-            default: false,
-        }),
-    };
-    async run() {
-        const auth = await readAuthConfig(this);
-        const { flags } = await this.parse(AppCreate);
-        let { projectId, name, description, appName } = flags;
-        // Modo interactivo si no se proporcionan los flags necesarios
-        if (!projectId || !name || !appName) {
-            console.log(chalk.blue.bold("\n  Listing all Projects \n"));
-            const projects = await getProjects(auth, this);
-            if (!projectId) {
-                const { project } = await inquirer.prompt([
-                    {
-                        choices: projects.map((project) => ({
-                            name: project.name,
-                            value: project,
-                        })),
-                        message: "Select a project to create the application in:",
-                        name: "project",
-                        type: "list",
-                    },
-                ]);
-                projectId = project.projectId;
-            }
-            if (!name || !appName) {
-                const appDetails = await inquirer.prompt([
-                    {
-                        message: "Enter the application name:",
-                        name: "name",
-                        type: "input",
-                        validate: (input) => (input ? true : "Application name is required"),
-                        default: name,
-                    },
-                    {
-                        message: "Enter the application description (optional):",
-                        name: "appDescription",
-                        type: "input",
-                        default: description,
-                    },
-                ]);
-                name = appDetails.name;
-                description = appDetails.appDescription;
-                const appNamePrompt = await inquirer.prompt([
-                    {
-                        default: appName || `${slugify(name)}`,
-                        message: "Enter the App name:",
-                        name: "appName",
-                        type: "input",
-                        validate: (input) => (input ? true : "App name is required"),
-                    },
-                ]);
-                appName = appNamePrompt.appName;
-            }
-        }
-        // Confirmar si no se especifica --skipConfirm
-        if (!flags.skipConfirm) {
-            const confirm = await inquirer.prompt([
-                {
-                    type: 'confirm',
-                    name: 'proceed',
-                    message: 'Do you want to create this application?',
-                    default: false,
-                },
-            ]);
-            if (!confirm.proceed) {
-                this.error(chalk.yellow("Application creation cancelled."));
-                return;
-            }
-        }
-        try {
-            const response = await axios.post(`${auth.url}/api/trpc/application.create`, {
-                json: {
-                    name,
-                    appDescription: description,
-                    appName,
-                    projectId,
-                },
-            }, {
-                headers: {
-                    "x-api-key": auth.token,
-                    "Content-Type": "application/json",
-                },
-            });
-            if (response.status !== 200) {
-                this.error(chalk.red("Error creating application"));
-            }
-            this.log(chalk.green(`Application '${name}' created successfully.`));
-        }
-        catch (error) {
-            this.error(chalk.red(`Error creating application: ${error.message}`));
-        }
-    }
-}

package/dist/commands/app/delete.d.ts

@@ -1,11 +0,0 @@
-import { Command } from "@oclif/core";
-export default class AppDelete extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        projectId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        applicationId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        skipConfirm: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/app/delete.js

@@ -1,106 +0,0 @@
-import { Command, Flags } from "@oclif/core";
-import axios from "axios";
-import chalk from "chalk";
-import inquirer from "inquirer";
-import { getProject, getProjects } from "../../utils/shared.js";
-import { readAuthConfig } from "../../utils/utils.js";
-export default class AppDelete extends Command {
-    static description = "Delete an application from a project.";
-    static examples = [
-        "$ <%= config.bin %> app delete",
-        "$ <%= config.bin %> app delete -p <projectId>",
-    ];
-    static flags = {
-        projectId: Flags.string({
-            char: "p",
-            description: "ID of the project",
-            required: false,
-        }),
-        applicationId: Flags.string({
-            char: 'a',
-            description: 'ID of the application to delete',
-            required: false,
-        }),
-        skipConfirm: Flags.boolean({
-            char: 'y',
-            description: 'Skip confirmation prompt',
-            default: false,
-        })
-    };
-    async run() {
-        const auth = await readAuthConfig(this);
-        const { flags } = await this.parse(AppDelete);
-        let { projectId, applicationId } = flags;
-        // Modo interactivo si no se proporcionan los flags necesarios
-        if (!projectId || !applicationId) {
-            console.log(chalk.blue.bold("\n  Listing all Projects \n"));
-            const projects = await getProjects(auth, this);
-            if (!projectId) {
-                const { project } = await inquirer.prompt([
-                    {
-                        choices: projects.map((project) => ({
-                            name: project.name,
-                            value: project,
-                        })),
-                        message: "Select a project to delete the application from:",
-                        name: "project",
-                        type: "list",
-                    },
-                ]);
-                projectId = project.projectId;
-            }
-            const projectSelected = await getProject(projectId, auth, this);
-            if (projectSelected.applications.length === 0) {
-                this.error(chalk.yellow("No applications found in this project."));
-            }
-            if (!applicationId) {
-                const appAnswers = await inquirer.prompt([
-                    {
-                        // @ts-ignore
-                        choices: projectSelected.applications.map((app) => ({
-                            name: app.name,
-                            value: app.applicationId,
-                        })),
-                        message: "Select the application to delete:",
-                        name: "selectedApp",
-                        type: "list",
-                    },
-                ]);
-                applicationId = appAnswers.selectedApp;
-            }
-        }
-        // Confirmar si no se especifica --skipConfirm
-        if (!flags.skipConfirm) {
-            const confirmAnswers = await inquirer.prompt([
-                {
-                    default: false,
-                    message: "Are you sure you want to delete this application?",
-                    name: "confirmDelete",
-                    type: "confirm",
-                },
-            ]);
-            if (!confirmAnswers.confirmDelete) {
-                this.error(chalk.yellow("Application deletion cancelled."));
-            }
-        }
-        try {
-            const deleteResponse = await axios.post(`${auth.url}/api/trpc/application.delete`, {
-                json: {
-                    applicationId,
-                },
-            }, {
-                headers: {
-                    "x-api-key": auth.token,
-                    "Content-Type": "application/json",
-                },
-            });
-            if (!deleteResponse.data.result.data.json) {
-                this.error(chalk.red("Error deleting application"));
-            }
-            this.log(chalk.green("Application deleted successfully."));
-        }
-        catch (error) {
-            this.error(chalk.red(`Failed to delete application: ${error.message}`));
-        }
-    }
-}

package/dist/commands/app/deploy.d.ts

@@ -1,11 +0,0 @@
-import { Command } from "@oclif/core";
-export default class AppDeploy extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        applicationId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        projectId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        skipConfirm: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}