@dokploy/cli 0.2.3 → 0.2.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mauricio Siu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/commands/env/pull.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class EnvPull extends Command {
+    static args: {
+        file: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/env/pull.js

@@ -0,0 +1,68 @@
+import { Args, 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 fs from 'fs';
+export default class EnvPull extends Command {
+    static args = {
+        file: Args.string({ description: 'write to file', required: true }),
+    };
+    static description = 'Store remote environment variables in local';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> .env.stage.local',
+    ];
+    static flags = {};
+    async run() {
+        const { args } = await this.parse(EnvPull);
+        if (fs.existsSync(args.file)) {
+            const { override } = await inquirer.prompt([
+                {
+                    message: `Do you want to override ${args.file} file?`,
+                    name: "override",
+                    default: false,
+                    type: "confirm",
+                },
+            ]);
+            if (!override) {
+                return;
+            }
+        }
+        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 the project:",
+                name: "project",
+                type: "list",
+            },
+        ]);
+        const projectId = project.projectId;
+        const projectSelected = await getProject(projectId, auth, this);
+        const choices = [
+            ...projectSelected.applications.map((app) => ({
+                name: `${app.name} (Application)`,
+                value: app.env,
+            })),
+            ...projectSelected.compose.map((compose) => ({
+                name: `${compose.name} (Compose)`,
+                value: compose.env,
+            })),
+        ];
+        const { env } = await inquirer.prompt([
+            {
+                choices,
+                message: "Select a service to pull the environment variables:",
+                name: "env",
+                type: "list",
+            },
+        ]);
+        fs.writeFileSync(args.file, env || "");
+        this.log(chalk.green("Environment variable write to file successful."));
+    }
+}

package/dist/commands/env/push.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class EnvPush extends Command {
+    static args: {
+        file: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/env/push.js

@@ -0,0 +1,106 @@
+import { Args, Command } from '@oclif/core';
+import fs from "fs";
+import chalk from "chalk";
+import inquirer from "inquirer";
+import { readAuthConfig } from "../../utils/utils.js";
+import { getProject, getProjects } from "../../utils/shared.js";
+import axios from "axios";
+export default class EnvPush extends Command {
+    static args = {
+        file: Args.string({ description: '.env file to push', required: true }),
+    };
+    static description = 'Push dotenv file to remote service';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> .env.stage.local',
+    ];
+    static flags = {};
+    async run() {
+        const { args, flags } = await this.parse(EnvPush);
+        if (!fs.existsSync(args.file)) {
+            console.log(chalk.red.bold(`\n File ${args.file} doesn't exists \n`));
+            return;
+        }
+        const { override } = await inquirer.prompt([
+            {
+                message: `This command will override entire remote environment variables. Do you want to continue?`,
+                name: "override",
+                default: false,
+                type: "confirm",
+            },
+        ]);
+        if (!override) {
+            return;
+        }
+        const fileContent = fs.readFileSync(args.file, 'utf-8');
+        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 the project:",
+                name: "project",
+                type: "list",
+            },
+        ]);
+        const projectId = project.projectId;
+        const projectSelected = await getProject(projectId, auth, this);
+        const choices = [
+            ...projectSelected.applications.map((app) => ({
+                name: `${app.name} (Application)`,
+                value: { serviceType: 'app', service: app },
+            })),
+            ...projectSelected.compose.map((compose) => ({
+                name: `${compose.name} (Compose)`,
+                value: { serviceType: 'compose', service: compose }
+            })),
+        ];
+        const { result: { serviceType, service } } = await inquirer.prompt([
+            {
+                choices,
+                message: "Select a service to pull the environment variables:",
+                name: "result",
+                type: "list",
+            },
+        ]);
+        if (serviceType === 'app') {
+            const { applicationId } = service;
+            const response = await axios.post(`${auth.url}/api/trpc/application.update`, {
+                json: {
+                    applicationId,
+                    env: fileContent
+                }
+            }, {
+                headers: {
+                    Authorization: `Bearer ${auth.token}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            if (response.status !== 200) {
+                this.error(chalk.red("Error stopping application"));
+            }
+            this.log(chalk.green("Environment variable push successful."));
+        }
+        if (serviceType === 'compose') {
+            const { composeId } = service;
+            const response = await axios.post(`${auth.url}/api/trpc/compose.update`, {
+                json: {
+                    composeId,
+                    env: fileContent
+                }
+            }, {
+                headers: {
+                    Authorization: `Bearer ${auth.token}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            if (response.status !== 200) {
+                this.error(chalk.red("Error stopping application"));
+            }
+            this.log(chalk.green("Environment variable push successful."));
+        }
+    }
+}

package/oclif.manifest.json

@@ -181,6 +181,66 @@
         "stop.js"
       ]
     },
+    "env:pull": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "write to file",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Store remote environment variables in local",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> .env.stage.local"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "env:pull",
+      "pluginAlias": "@dokploy/cli",
+      "pluginName": "@dokploy/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "env",
+        "pull.js"
+      ]
+    },
+    "env:push": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": ".env file to push",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Push dotenv file to remote service",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> .env.stage.local"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "env:push",
+      "pluginAlias": "@dokploy/cli",
+      "pluginName": "@dokploy/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "env",
+        "push.js"
+      ]
+    },
     "project:create": {
       "aliases": [],
       "args": {},
@@ -891,5 +951,5 @@
       ]
     }
   },
-  "version": "v0.2.3"
+  "version": "v0.2.4"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dokploy/cli",
   "description": "A CLI to manage dokploy server remotely",
-  "version": "v0.2.3",
+  "version": "v0.2.4",
   "author": "Mauricio Siu",
   "licenses": [{
     "type": "MIT",
@@ -81,7 +81,8 @@
     "posttest": "pnpm run lint",
     "prepack": "oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "version": "oclif readme && git add README.md",
+    "publish" :"npm publish"
   },
   "types": "dist/index.d.ts"
 }

package/{README.md → readme.md}

@@ -17,6 +17,7 @@ Dokploy CLI is a powerful and versatile command-line tool designed to remotely m
   - [Authentication](#authentication)
   - [Project Management](#project-management)
   - [Application Management](#application-management)
+  - [Environment Management](#environment-management)
   - [Database Management](#database-management)
 - [Contributing](#contributing)
 - [Support](#support)
@@ -25,7 +26,7 @@ Dokploy CLI is a powerful and versatile command-line tool designed to remotely m
 ## Installation
 
 ```sh-session
-$ npm install -g dokploy
+$ npm install -g @dokploy/cli
 ```
 
 ## Usage
@@ -63,35 +64,45 @@ USAGE
 - `dokploy app:deploy`: Deploy an application.
 - `dokploy app:stop`: Stop a running application.
 
+### Enviroment Management
+
+- `dokploy env pull <file>`: Pull environment variables from Dokploy in a <file>.
+- `dokploy env push <file>`: Push environment variables to Dokploy from a <file>.
+
 ### 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`
@@ -103,6 +114,10 @@ For more information about a specific command, use:
 $ dokploy [COMMAND] --help
 ```
 
+## Contributing
+
+If you want to contribute to Dokploy CLI, please check out our [Contributing Guide](https://github.com/Dokploy/cli/blob/main/CONTRIBUTING.md).
+
 ## Support
 
 If you encounter any issues or have any questions, please [open an issue](https://github.com/yourusername/dokploy/issues) in our GitHub repository.