mirror of
https://github.com/Dokploy/cli.git
synced 2026-06-15 20:25:22 +02:00
37f4b8b56e
- Refactored ProjectInfo command to retrieve project information based on environments. - Added detailed logging for applications, compose services, and databases categorized by environment. - Implemented total counts for applications and databases across all environments. - Improved error handling for cases with no environments found.
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.
Table of Contents
Installation
$ npm install -g @dokploy/cli
Usage
$ 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.
Enviroment Management
dokploy env pull <file>: Pull environment variables from Dokploy in a .dokploy env push <file>: Push environment variables to Dokploy from a .
Database Management
Dokploy supports various types of databases:
MariaDB
dokploy database:mariadb:createdokploy database:mariadb:deletedokploy database:mariadb:deploydokploy database:mariadb:stop
MongoDB
dokploy database:mongo:createdokploy database:mongo:deletedokploy database:mongo:deploydokploy database:mongo:stop
MySQL
dokploy database:mysql:createdokploy database:mysql:deletedokploy database:mysql:deploydokploy database:mysql:stop
PostgreSQL
dokploy database:postgres:createdokploy database:postgres:deletedokploy database:postgres:deploydokploy database:postgres:stop
Redis
dokploy database:redis:createdokploy database:redis:deletedokploy database:redis:deploydokploy database:redis:stop
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.
Support
If you encounter any issues or have any questions, please open an issue in our GitHub repository.
License
This project is licensed under the MIT License.