mirror of
https://github.com/Dokploy/cli.git
synced 2026-06-15 20:25:22 +02:00
0869e2d69a
- 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.
64 lines
1.2 KiB
Markdown
64 lines
1.2 KiB
Markdown
# Contributing
|
|
|
|
Thanks for your interest in contributing to Dokploy CLI!
|
|
|
|
Before you start, please discuss the feature/bug via [GitHub issues](https://github.com/Dokploy/cli/issues).
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
git clone https://github.com/Dokploy/cli.git
|
|
cd cli
|
|
pnpm install
|
|
```
|
|
|
|
Create a `.env` file with your credentials:
|
|
|
|
```env
|
|
DOKPLOY_URL="https://your-server.dokploy.com"
|
|
DOKPLOY_API_KEY="YOUR_API_KEY"
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# 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:
|
|
|
|
1. Replace `openapi.json` with the latest spec from the [Dokploy repo](https://github.com/Dokploy/dokploy)
|
|
2. Run `pnpm run generate`
|
|
|
|
## Commit convention
|
|
|
|
Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
|
|
|
|
```
|
|
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!
|