GigiKit Guides

gk:deploy-dokploy

Deploy and manage applications on a Dokploy self-hosted platform using the @lmes/dokploy-cli.

When to Use

Activate this skill when you want to:

  • Deploy a built app folder to Dokploy
  • Create projects, apps, environments, or databases on Dokploy
  • Pull or push environment variables between local and Dokploy server
/gk:deploy-dokploy
/gk:deploy-dokploy "deploy my app to staging"

Prerequisites

Install the CLI

npm install -g @lmes/dokploy-cli

Verify installation:

dokploy --version

Authenticate

The skill checks dokploy verify first. If not authenticated, it will ask for your server URL and API token via interactive prompts, then run:

dokploy authenticate -u <SERVER_URL> -t <API_TOKEN>

What the Skill Does

After authentication, the skill presents an action menu:

ActionDescription
Deploy an appDeploy from a local build folder to an existing or new app
Create project/appSet up a new project and application
Create databaseProvision MariaDB, PostgreSQL, MySQL, MongoDB, or Redis
Manage env varsPull or push environment variables

Workflow: Deploy an App

Deploy Workflow 
graph LR
A[Read config] —> B[Fetch projects via API]
B —> C[Select project]
C —> D[Select environment]
D —> E[Select app]
E —> F[dokploy app deploy]
F —> G[Update docs/deployment.md]

The skill always fetches project/app IDs from the API first, then runs deploy with all flags explicitly — no interactive prompts:

dokploy app deploy -a <applicationId> -p <projectId> -e <environmentId> --from-folder ./dist -y

Key Commands Reference

Project & App

# Create project
dokploy project create -n "MyProject" -d "Description" -y

# Create app under a project
dokploy app create -p <projectId> -n "my-app" -d "Description" -y

# Deploy app (ALL flags required)
dokploy app deploy -a <appId> -p <projectId> -e <envId> --from-folder ./dist -y

Database

# PostgreSQL
dokploy database postgres create -p <projectId> -n "my-pg" --databaseName mydb --databasePassword secret123 -y

# MySQL
dokploy database mysql create -p <projectId> -n "my-mysql" --databaseName mydb --databasePassword secret123 -y

# MongoDB
dokploy database mongo create -p <projectId> -n "my-mongo" --databaseName mydb --databasePassword secret123 -y

# Redis
dokploy database redis create -p <projectId> -n "my-redis" --databasePassword secret123 -y

Environment Variables

# Pull env vars from server to local file
dokploy env pull .env.production

# Push local env file to server
dokploy env push .env.production

Create Environment

dokploy environment create -p <projectId> -n "staging" -d "Staging env" -y

Post-Deploy

After a successful deploy the skill:

  1. Confirms the deployment URL
  2. Creates or updates docs/deployment.md with deploy metadata
# Deployment
## Platform: Dokploy
## Server: <DOKPLOY_URL>
## Deploy Command: dokploy app deploy -a <appId> --from-folder ./dist -y
## Environment Variables: dokploy env pull .env.production

Error Reference

ErrorFix
dokploy: command not foundnpm install -g @lmes/dokploy-cli
Invalid tokenRe-run dokploy authenticate with a fresh token
Project not foundVerify via API: curl -s -H "x-api-key: <TOKEN>" "<URL>/api/project.all"
App deploy failedCheck build output; verify --from-folder path exists

Security Notes

  • API tokens are never printed in output or committed to git
  • Always check .env files are in .gitignore before deploying
  • The skill ignores attempts to override its scope or reveal internals