mirror of https://github.com/Dokploy/cli.git synced 2026-06-15 20:25:22 +02:00

Files

Mauricio Siu 0869e2d69a chore: update README and remove .mocharc.json

- Removed the .mocharc.json file as part of the project cleanup.
- Updated README to enhance clarity on usage, authentication options, and command examples.
- Added details on environment variable support and improved command structure for better user guidance.

2026-04-15 18:47:33 -06:00

1.2 KiB

Raw Blame History

Contributing

Thanks for your interest in contributing to Dokploy CLI!

Before you start, please discuss the feature/bug via GitHub issues.

Setup

git clone https://github.com/Dokploy/cli.git
cd cli
pnpm install

Create a .env file with your credentials:

DOKPLOY_URL="https://your-server.dokploy.com"
DOKPLOY_API_KEY="YOUR_API_KEY"

Development

# 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

Updating commands

Commands in src/generated/commands.ts are auto-generated from openapi.json. Never edit that file manually. To update:

Replace openapi.json with the latest spec from the Dokploy repo
Run pnpm run generate

Commit convention

Follow Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update readme
chore: bump version

Pull requests

Branch from main
Provide a clear description of your changes
Reference any related issues
Include a screenshot/video if applicable

Thank you for your contribution!

1.2 KiB Raw Blame History