@dokploy/cli 0.2.3

package/README.md

@@ -0,0 +1,112 @@
+# 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)
+  - [Database Management](#database-management)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Installation
+
+```sh-session
+$ npm install -g dokploy
+```
+
+## Usage
+
+```sh-session
+$ dokploy COMMAND
+running command...
+
+$ dokploy --version
+dokploy/0.0.0 darwin-arm64 node-v18.18.0
+
+$ dokploy --help [COMMAND]
+USAGE
+  $ dokploy COMMAND
+...
+```
+
+## Commands
+
+### Authentication
+
+- `dokploy authenticate`: Authenticate with the Dokploy server.
+- `dokploy verify`: Verify current authentication.
+
+### Project Management
+
+- `dokploy project:create`: Create a new project.
+- `dokploy project:info`: Get information about an existing project.
+- `dokploy project:list`: List all projects.
+
+### Application Management
+
+- `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.
+
+### Database Management
+
+Dokploy supports various types of databases:
+
+#### MariaDB
+- `dokploy database:mariadb:create`
+- `dokploy database:mariadb:delete`
+- `dokploy database:mariadb:deploy`
+- `dokploy database:mariadb:stop`
+
+#### MongoDB
+- `dokploy database:mongo:create`
+- `dokploy database:mongo:delete`
+- `dokploy database:mongo:deploy`
+- `dokploy database:mongo:stop`
+
+#### MySQL
+- `dokploy database:mysql:create`
+- `dokploy database:mysql:delete`
+- `dokploy database:mysql:deploy`
+- `dokploy database:mysql:stop`
+
+#### PostgreSQL
+- `dokploy database:postgres:create`
+- `dokploy database:postgres:delete`
+- `dokploy database:postgres:deploy`
+- `dokploy database:postgres:stop`
+
+#### Redis
+- `dokploy database:redis:create`
+- `dokploy database:redis:delete`
+- `dokploy database:redis:deploy`
+- `dokploy database:redis:stop`
+
+For more information about a specific command, use:
+
+```sh-session
+$ dokploy [COMMAND] --help
+```
+
+## Support
+
+If you encounter any issues or have any questions, please [open an issue](https://github.com/yourusername/dokploy/issues) in our GitHub repository.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

package/bin/dev.cmd

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

package/bin/dev.js

@@ -0,0 +1,6 @@
+#!/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

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

package/bin/run.js

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

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

@@ -0,0 +1,13 @@
+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>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/app/create.js

@@ -0,0 +1,77 @@
+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,
+        }),
+    };
+    async run() {
+        const auth = await readAuthConfig(this);
+        const { flags } = await this.parse(AppCreate);
+        let { projectId } = flags;
+        if (!projectId) {
+            console.log(chalk.blue.bold("\n  Listing all Projects \n"));
+            const projects = await getProjects(auth, this);
+            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;
+            const appDetails = await inquirer.prompt([
+                {
+                    message: "Enter the application name:",
+                    name: "name",
+                    type: "input",
+                    validate: (input) => (input ? true : "Application name is required"),
+                },
+                {
+                    message: "Enter the application description (optional):",
+                    name: "appDescription",
+                    type: "input",
+                },
+            ]);
+            const appName = await inquirer.prompt([
+                {
+                    default: `${slugify(project.name)}-${appDetails.name}`,
+                    message: "Enter the App name: (optional):",
+                    name: "appName",
+                    type: "input",
+                    validate: (input) => (input ? true : "App name is required"),
+                },
+            ]);
+            const response = await axios.post(`${auth.url}/api/trpc/application.create`, {
+                json: {
+                    ...appDetails,
+                    appName: appName.appName,
+                    projectId: project.projectId,
+                },
+            }, {
+                headers: {
+                    Authorization: `Bearer ${auth.token}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            if (response.status !== 200) {
+                this.error(chalk.red("Error creating application"));
+            }
+            this.log(chalk.green(`Application '${appDetails.name}' created successfully.`));
+        }
+    }
+}

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

@@ -0,0 +1,9 @@
+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>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/app/delete.js

@@ -0,0 +1,84 @@
+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,
+        }),
+    };
+    async run() {
+        const auth = await readAuthConfig(this);
+        const { flags } = await this.parse(AppDelete);
+        let { projectId } = flags;
+        if (!projectId) {
+            console.log(chalk.blue.bold("\n  Listing all Projects \n"));
+            const projects = await getProjects(auth, this);
+            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;
+            const projectSelected = await getProject(projectId, auth, this);
+            if (projectSelected.applications.length === 0) {
+                this.error(chalk.yellow("No applications found in this project."));
+            }
+            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",
+                },
+            ]);
+            const applicationId = appAnswers.selectedApp;
+            // // Confirmar eliminación
+            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."));
+            }
+            const deleteResponse = await axios.post(`${auth.url}/api/trpc/application.delete`, {
+                json: {
+                    applicationId,
+                },
+            }, {
+                headers: {
+                    Authorization: `Bearer ${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."));
+        }
+    }
+}

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

@@ -0,0 +1,6 @@
+import { Command } from "@oclif/core";
+export default class AppDeploy extends Command {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/app/deploy.js

@@ -0,0 +1,69 @@
+import { Command } from "@oclif/core";
+import { readAuthConfig } from "../../utils/utils.js";
+import chalk from "chalk";
+import { getProject, getProjects } from "../../utils/shared.js";
+import inquirer from "inquirer";
+import axios from "axios";
+export default class AppDeploy extends Command {
+    static description = "Deploy an application to a project.";
+    static examples = ["$ <%= config.bin %> app deploy"];
+    async run() {
+        const auth = await readAuthConfig(this);
+        console.log(chalk.blue.bold("\n  Listing all Projects \n"));
+        const projects = await getProjects(auth, this);
+        const { project } = await inquirer.prompt([
+            {
+                choices: projects.map((project) => ({
+                    name: project.name,
+                    value: project,
+                })),
+                message: "Select a project to deploy the application in:",
+                name: "project",
+                type: "list",
+            },
+        ]);
+        const 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."));
+        }
+        const appAnswers = await inquirer.prompt([
+            {
+                // @ts-ignore
+                choices: projectSelected.applications.map((app) => ({
+                    name: app.name,
+                    value: app.applicationId,
+                })),
+                message: "Select the application to deploy:",
+                name: "selectedApp",
+                type: "list",
+            },
+        ]);
+        const applicationId = appAnswers.selectedApp;
+        const confirmAnswers = await inquirer.prompt([
+            {
+                default: false,
+                message: "Are you sure you want to deploy this application?",
+                name: "confirmDelete",
+                type: "confirm",
+            },
+        ]);
+        if (!confirmAnswers.confirmDelete) {
+            this.error(chalk.yellow("Application deployment cancelled."));
+        }
+        const response = await axios.post(`${auth.url}/api/trpc/application.deploy`, {
+            json: {
+                applicationId,
+            },
+        }, {
+            headers: {
+                Authorization: `Bearer ${auth.token}`,
+                "Content-Type": "application/json",
+            },
+        });
+        if (response.status !== 200) {
+            this.error(chalk.red("Error deploying application"));
+        }
+        this.log(chalk.green("Application deploy successful."));
+    }
+}

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

@@ -0,0 +1,6 @@
+import { Command } from "@oclif/core";
+export default class AppStop extends Command {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/app/stop.js

@@ -0,0 +1,69 @@
+import { Command } from "@oclif/core";
+import { readAuthConfig } from "../../utils/utils.js";
+import chalk from "chalk";
+import inquirer from "inquirer";
+import { getProject, getProjects } from "../../utils/shared.js";
+import axios from "axios";
+export default class AppStop extends Command {
+    static description = "Stop an application from a project.";
+    static examples = ["$ <%= config.bin %> app stop"];
+    async run() {
+        const auth = await readAuthConfig(this);
+        console.log(chalk.blue.bold("\n  Listing all Projects \n"));
+        const projects = await getProjects(auth, this);
+        const { project } = await inquirer.prompt([
+            {
+                choices: projects.map((project) => ({
+                    name: project.name,
+                    value: project,
+                })),
+                message: "Select a project to stop the application in:",
+                name: "project",
+                type: "list",
+            },
+        ]);
+        const 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."));
+        }
+        const appAnswers = await inquirer.prompt([
+            {
+                // @ts-ignore
+                choices: projectSelected.applications.map((app) => ({
+                    name: app.name,
+                    value: app.applicationId,
+                })),
+                message: "Select the application to stop:",
+                name: "selectedApp",
+                type: "list",
+            },
+        ]);
+        const applicationId = appAnswers.selectedApp;
+        const confirmAnswers = await inquirer.prompt([
+            {
+                default: false,
+                message: "Are you sure you want to stop this application?",
+                name: "confirmDelete",
+                type: "confirm",
+            },
+        ]);
+        if (!confirmAnswers.confirmDelete) {
+            this.error(chalk.yellow("Application stop cancelled."));
+        }
+        const response = await axios.post(`${auth.url}/api/trpc/application.stop`, {
+            json: {
+                applicationId,
+            },
+        }, {
+            headers: {
+                Authorization: `Bearer ${auth.token}`,
+                "Content-Type": "application/json",
+            },
+        });
+        if (response.status !== 200) {
+            this.error(chalk.red("Error stopping application"));
+        }
+        this.log(chalk.green("Application stop successful."));
+    }
+}

package/dist/commands/authenticate.d.ts

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

package/dist/commands/authenticate.js

@@ -0,0 +1,79 @@
+import { Command, Flags } from "@oclif/core";
+import axios from "axios";
+import chalk from "chalk";
+import inquirer from "inquirer";
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { fileURLToPath } from "node:url";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const configPath = path.join(__dirname, "..", "..", "config.json");
+export default class Authenticate extends Command {
+    static description = "Authenticate the user by saving server URL and token";
+    static examples = [
+        "$ <%= config.bin %> <%= command.id %> --url=https://panel.dokploy.com --token=MRTHGZDGMRZWM43EMZSHGZTTMRTHGZDGONSGMZDTMY",
+        "$ <%= config.bin %> <%= command.id %> -u https://panel.dokploy.com -t MRTHGZDGMRZWM43EMZSHGZTTMRTHGZDGONSGMZDTMY",
+    ];
+    static flags = {
+        token: Flags.string({
+            char: "t",
+            description: "Authentication token",
+        }),
+        url: Flags.string({
+            char: "u",
+            description: "Server URL",
+        }),
+    };
+    async run() {
+        console.log(chalk.blue.bold("\n  Welcome to Dokploy CLI Authentication \n"));
+        const { flags } = await this.parse(Authenticate);
+        let answers = {};
+        const questions = [];
+        let config = {};
+        if (fs.existsSync(configPath)) {
+            const configFileContent = fs.readFileSync(configPath, "utf8");
+            config = JSON.parse(configFileContent);
+        }
+        if (!flags.url) {
+            questions.push({
+                default: config.url,
+                message: chalk.green("Enter your server URL (e.g., https://panel.dokploy.com): "),
+                name: "url",
+                type: "input",
+                validate: (input) => (input ? true : "Server URL is required"),
+            });
+        }
+        if (!flags.token) {
+            questions.push({
+                default: config.token,
+                message: chalk.green("Enter your authentication token (e.g., MRTHGZDGMRZWM43EMZSHGZTTMRTHGZDGONSGMZDTMY=): "),
+                name: "token",
+                type: "input",
+                validate: (input) => input ? true : "Authentication token is required",
+            });
+        }
+        if (questions.length > 0) {
+            answers = await inquirer.prompt(questions);
+        }
+        const url = flags.url || answers.url;
+        const token = flags.token || answers.token;
+        config.token = token;
+        config.url = url;
+        try {
+            console.log(`\n${chalk.blue("Validating server...")}`);
+            await axios.post(`${url}/api/trpc/auth.verifyToken`, {}, {
+                headers: {
+                    Authorization: `Bearer ${token}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
+            this.log(chalk.green("Authentication details saved successfully."));
+        }
+        catch (error) {
+            this.error(
+            // @ts-expect-error - Type
+            chalk.red(`Failed to save authentication details: ${error.message}`));
+        }
+    }
+}

package/dist/commands/database/mariadb/create.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "@oclif/core";
+export default class DatabaseMariadbCreate 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>;
+    };
+    run(): Promise<void>;
+}