Dokploy CLI (英语)
Dokploy CLI 是远程管理您 Dokploy 服务器的指令行工具 。 它规定 449个命令 从 Dokploy OpenAPI spec 自动生成,覆盖每个API 端点.
安装
npm install -g @dokploy/cli
认证
备选案文1: auth 命令
dokploy auth -u https://panel.dokploy.com -t YOUR_API_KEY
备选案文2:环境变量
export DOKPLOY_URL="https://panel.dokploy.com"
export DOKPLOY_API_KEY="YOUR_API_KEY"
备选案文3: .env 文件
创建一个 .env 在工作目录中的文件 :
DOKPLOY_URL="https://panel.dokploy.com"
DOKPLOY_API_KEY="YOUR_API_KEY"
CLI自动加载. 贝壳环境变量优先于 .env 文档.
使用量
dokploy <group> <action> [options]
实例
# List all projects
dokploy project all
# Get a specific project
dokploy project one --projectId abc123
# Create an application
dokploy application create --name "my-app" --environmentId env123
# Deploy an application
dokploy application deploy --applicationId app123
# Create a postgres database
dokploy postgres create --name "my-db" --environmentId env123
# Stop a database
dokploy postgres stop --postgresId pg123
# Get raw JSON output
dokploy project all --json
获得帮助
# List all groups
dokploy --help
# List actions in a group
dokploy application --help
# See options for a specific action
dokploy application deploy --help
可用的指令组
| 组 | 图标 | 组 | 图标 |
|---|---|---|---|
admin | 1个 | notification | 第38条 |
ai | 第9条 | organization | 10个 |
application | 29个 | patch | 第12条 |
backup | 第11个 | port | 页:1 |
bitbucket | 第7条 | postgres | 页:1 |
certificates | 页:1 | preview-deployment | 页:1 |
cluster | 页:1 | project | 第8条 |
compose | 第28条 | redirects | 页:1 |
deployment | 第8条 | redis | 页:1 |
destination | 6个 | registry | 第7条 |
docker | 第7条 | rollback | 2个 |
domain | 第9条 | schedule | 6个 |
environment | 第7条 | security | 页:1 |
gitea | 第8条 | server | 16个 |
github | 6个 | settings | 第49条 |
gitlab | 第7条 | ssh-key | 6个 |
git-provider | 2个 | sso | 10个 |
license-key | 6个 | stripe | 第7条 |
mariadb | 页:1 | swarm | 3个 |
mongo | 页:1 | user | 第 18 条 |
mounts | 6个 | volume-backups | 6个 |
mysql | 页:1 |
发展
# Install dependencies
pnpm install
# Run in dev mode
pnpm run dev -- project all
# Regenerate commands from OpenAPI spec
pnpm run generate
# Build
pnpm run build
# Lint & format
pnpm run lint
更新命令
命令是自动生成的 openapi.json。更新:
- 替换
openapi.json带有来自 Dokploy 重传 - 运行
pnpm run generate - 以
pnpm run build
捐款
如果你想向Dokploy CLI捐款,请检查我们 贡献指南。 。 。 .
支助
如果你遇到任何问题或问题,请 打开一个问题 在我们的 GitHub 仓库中.
许可证
本项目根据以下规定获得许可证: MIT 许可证。 。 。 .