From 338b3c89f2a78b913f6594b6bf0a5d008bd0191d Mon Sep 17 00:00:00 2001 From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com> Date: Sat, 22 Jun 2024 23:36:29 -0600 Subject: [PATCH] chore: update readme --- package.json | 4 + readme.md | 450 ++++++++++----------------------------------------- 2 files changed, 87 insertions(+), 367 deletions(-) diff --git a/package.json b/package.json index 6451eed..4e73883 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,10 @@ "description": "A CLI to manage dokploy server remotely", "version": "0.0.0", "author": "Mauricio Siu", + "licenses": [{ + "type": "MIT", + "url": "https://github.com/Dokploy/cli/blob/master/LICENSE" + }], "bin": { "dokploy": "./bin/run.js" }, diff --git a/readme.md b/readme.md index 1bca5ef..085bcc3 100644 --- a/readme.md +++ b/readme.md @@ -1,396 +1,112 @@ -dokploy -================= +# Dokploy CLI -A CLI to manage dokploy server remotely + +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. -[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Commands](#commands) + - [Authentication](#authentication) + - [Project Management](#project-management) + - [Application Management](#application-management) + - [Database Management](#database-management) +- [Contributing](#contributing) +- [Support](#support) +- [License](#license) + +## Installation - -* [Usage](#usage) -* [Commands](#commands) - -# Usage - ```sh-session $ npm install -g dokploy +``` + +## Usage + +```sh-session $ dokploy COMMAND running command... -$ dokploy (--version) + +$ dokploy --version dokploy/0.0.0 darwin-arm64 node-v18.18.0 + $ dokploy --help [COMMAND] USAGE $ dokploy COMMAND ... ``` - -# Commands - -* [`dokploy hello PERSON`](#dokploy-hello-person) -* [`dokploy hello world`](#dokploy-hello-world) -* [`dokploy help [COMMAND]`](#dokploy-help-command) -* [`dokploy plugins`](#dokploy-plugins) -* [`dokploy plugins add PLUGIN`](#dokploy-plugins-add-plugin) -* [`dokploy plugins:inspect PLUGIN...`](#dokploy-pluginsinspect-plugin) -* [`dokploy plugins install PLUGIN`](#dokploy-plugins-install-plugin) -* [`dokploy plugins link PATH`](#dokploy-plugins-link-path) -* [`dokploy plugins remove [PLUGIN]`](#dokploy-plugins-remove-plugin) -* [`dokploy plugins reset`](#dokploy-plugins-reset) -* [`dokploy plugins uninstall [PLUGIN]`](#dokploy-plugins-uninstall-plugin) -* [`dokploy plugins unlink [PLUGIN]`](#dokploy-plugins-unlink-plugin) -* [`dokploy plugins update`](#dokploy-plugins-update) -## `dokploy hello PERSON` +## Commands -Say hello +### Authentication -``` -USAGE - $ dokploy hello PERSON -f +- `dokploy authenticate`: Authenticate with the Dokploy server. +- `dokploy verify`: Verify current authentication. -ARGUMENTS - PERSON Person to say hello to +### Project Management -FLAGS - -f, --from= (required) Who is saying hello +- `dokploy project:create`: Create a new project. +- `dokploy project:info`: Get information about an existing project. +- `dokploy project:list`: List all projects. -DESCRIPTION - Say hello +### Application Management -EXAMPLES - $ dokploy hello friend --from oclif - hello friend from oclif! (./src/commands/hello/index.ts) +- `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. + +### 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: + +```sh-session +$ dokploy [COMMAND] --help ``` -_See code: [src/commands/hello/index.ts](https://github.com/Dokploy/cli/blob/v0.0.0/src/commands/hello/index.ts)_ +## Support -## `dokploy hello world` +If you encounter any issues or have any questions, please [open an issue](https://github.com/yourusername/dokploy/issues) in our GitHub repository. -Say hello world +## License -``` -USAGE - $ dokploy hello world - -DESCRIPTION - Say hello world - -EXAMPLES - $ dokploy hello world - hello world! (./src/commands/hello/world.ts) -``` - -_See code: [src/commands/hello/world.ts](https://github.com/Dokploy/cli/blob/v0.0.0/src/commands/hello/world.ts)_ - -## `dokploy help [COMMAND]` - -Display help for dokploy. - -``` -USAGE - $ dokploy help [COMMAND...] [-n] - -ARGUMENTS - COMMAND... Command to show help for. - -FLAGS - -n, --nested-commands Include all nested commands in the output. - -DESCRIPTION - Display help for dokploy. -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.1.0/src/commands/help.ts)_ - -## `dokploy plugins` - -List installed plugins. - -``` -USAGE - $ dokploy plugins [--json] [--core] - -FLAGS - --core Show core plugins. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - List installed plugins. - -EXAMPLES - $ dokploy plugins -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/index.ts)_ - -## `dokploy plugins add PLUGIN` - -Installs a plugin into dokploy. - -``` -USAGE - $ dokploy plugins add PLUGIN... [--json] [-f] [-h] [-s | -v] - -ARGUMENTS - PLUGIN... Plugin to install. - -FLAGS - -f, --force Force npm to fetch remote resources even if a local copy exists on disk. - -h, --help Show CLI help. - -s, --silent Silences npm output. - -v, --verbose Show verbose npm output. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Installs a plugin into dokploy. - - Uses bundled npm executable to install plugins into /Users/mauricio/.local/share/dokploy - - Installation of a user-installed plugin will override a core plugin. - - Use the DOKPLOY_NPM_LOG_LEVEL environment variable to set the npm loglevel. - Use the DOKPLOY_NPM_REGISTRY environment variable to set the npm registry. - -ALIASES - $ dokploy plugins add - -EXAMPLES - Install a plugin from npm registry. - - $ dokploy plugins add myplugin - - Install a plugin from a github url. - - $ dokploy plugins add https://github.com/someuser/someplugin - - Install a plugin from a github slug. - - $ dokploy plugins add someuser/someplugin -``` - -## `dokploy plugins:inspect PLUGIN...` - -Displays installation properties of a plugin. - -``` -USAGE - $ dokploy plugins inspect PLUGIN... - -ARGUMENTS - PLUGIN... [default: .] Plugin to inspect. - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Displays installation properties of a plugin. - -EXAMPLES - $ dokploy plugins inspect myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/inspect.ts)_ - -## `dokploy plugins install PLUGIN` - -Installs a plugin into dokploy. - -``` -USAGE - $ dokploy plugins install PLUGIN... [--json] [-f] [-h] [-s | -v] - -ARGUMENTS - PLUGIN... Plugin to install. - -FLAGS - -f, --force Force npm to fetch remote resources even if a local copy exists on disk. - -h, --help Show CLI help. - -s, --silent Silences npm output. - -v, --verbose Show verbose npm output. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Installs a plugin into dokploy. - - Uses bundled npm executable to install plugins into /Users/mauricio/.local/share/dokploy - - Installation of a user-installed plugin will override a core plugin. - - Use the DOKPLOY_NPM_LOG_LEVEL environment variable to set the npm loglevel. - Use the DOKPLOY_NPM_REGISTRY environment variable to set the npm registry. - -ALIASES - $ dokploy plugins add - -EXAMPLES - Install a plugin from npm registry. - - $ dokploy plugins install myplugin - - Install a plugin from a github url. - - $ dokploy plugins install https://github.com/someuser/someplugin - - Install a plugin from a github slug. - - $ dokploy plugins install someuser/someplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/install.ts)_ - -## `dokploy plugins link PATH` - -Links a plugin into the CLI for development. - -``` -USAGE - $ dokploy plugins link PATH [-h] [--install] [-v] - -ARGUMENTS - PATH [default: .] path to plugin - -FLAGS - -h, --help Show CLI help. - -v, --verbose - --[no-]install Install dependencies after linking the plugin. - -DESCRIPTION - Links a plugin into the CLI for development. - Installation of a linked plugin will override a user-installed or core plugin. - - e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' - command will override the user-installed or core plugin implementation. This is useful for development work. - - -EXAMPLES - $ dokploy plugins link myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/link.ts)_ - -## `dokploy plugins remove [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ dokploy plugins remove [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ dokploy plugins unlink - $ dokploy plugins remove - -EXAMPLES - $ dokploy plugins remove myplugin -``` - -## `dokploy plugins reset` - -Remove all user-installed and linked plugins. - -``` -USAGE - $ dokploy plugins reset [--hard] [--reinstall] - -FLAGS - --hard Delete node_modules and package manager related files in addition to uninstalling plugins. - --reinstall Reinstall all plugins after uninstalling. -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/reset.ts)_ - -## `dokploy plugins uninstall [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ dokploy plugins uninstall [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ dokploy plugins unlink - $ dokploy plugins remove - -EXAMPLES - $ dokploy plugins uninstall myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/uninstall.ts)_ - -## `dokploy plugins unlink [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ dokploy plugins unlink [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ dokploy plugins unlink - $ dokploy plugins remove - -EXAMPLES - $ dokploy plugins unlink myplugin -``` - -## `dokploy plugins update` - -Update installed plugins. - -``` -USAGE - $ dokploy plugins update [-h] [-v] - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Update installed plugins. -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/src/commands/plugins/update.ts)_ - +This project is licensed under the [MIT License](LICENSE). \ No newline at end of file