@dokploy/cli v0.2.3

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
• Usage
• Commands
  • Authentication
  • Project Management
  • Application Management
  • Database Management
• Contributing
• Support
• License

Installation

$ npm install -g dokploy

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.

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:

$ dokploy [COMMAND] --help

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.