Skip to content

readme.md

Latest commit

 

History

History
161 lines (111 loc) · 4.37 KB

readme.md

File metadata and controls

161 lines (111 loc) · 4.37 KB

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
...

Project Configuration

You can create a .dokploy.json file in any project directory to set default values for project, environment, and application. This lets you skip interactive prompts when running commands.

$ cd ~/my-app
$ dokploy init

This walks you through selecting a project, environment, and (optionally) an application, then writes a .dokploy.json file:

{
  "projectId": "abc123",
  "environmentId": "def456",
  "applicationId": "ghi789"
}

Now commands run from that directory (or any subdirectory) will use these defaults automatically:

$ dokploy app deploy -y      # deploys the configured application
$ dokploy env pull .env.local # pulls env vars without prompts

Flags passed on the command line always take priority over .dokploy.json values.

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.

Environment Management

  • dokploy environment:create: Create a new environment.
  • dokploy environment:delete: Delete an existing environment.

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: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

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.