Skip to content

README.md

Latest commit

 

History

History
132 lines (80 loc) · 2.85 KB

README.md

File metadata and controls

132 lines (80 loc) · 2.85 KB

Discloud CLI

Installation

Welcome to the Discloud CLI installation documentation. Follow the instructions below according to your operating system to install and start using the tool.

Note: Before proceeding, ensure you have the necessary prerequisites installed on your machine.

📋 Prerequisites

  • Operating System:
    • Linux arm64/x64
    • MacOS arm64
    • Windows arm64/x64

🐧 For Linux / MacOS

On Linux or MacOS, the CLI is distributed as a raw binary file.

🪟 For Windows

The distribution for Windows is provided through winget or standalone executable setup (.exe). This setup bundles the binary and automatically configures the system environment variables.

Winget

  • Open the terminal and paste the command below.
winget install Discloud.CLI

Setup .exe

  1. Download the Setup: Go to the official releases page and download the file discloud-cli-x64-setup.exe.

  2. Run the Setup: Double-click the downloaded file. If Windows SmartScreen or Defender prompts you, select More info > Run anyway.

  3. Follow the Wizard:

    • Click Next.
    • Read and accept the license terms (I Agree).
    • Choose the installation directory (default is recommended).
    • Click Install.

  4. Finish: Once completed, click Finish.

✅ Verify Installation

After completing the steps above, verify that the installation was successful by typing the following command in your terminal or command prompt:

discloud --version

If installed correctly, the output will display the current version number (e.g., v1.0.0).

🔐 Authentication (Login)

To use the CLI commands and manage your bots/applications, you must authenticate your account:

discloud login

The system will either generate an OTP code or open your default browser to confirm access to your DisCloud account.

CONTRIBUTING

For details see CONTRIBUTING.md.

Getting Started

Prerequisites

Preparing for development

  • Get the dependencies

    dart pub get

Preparing for format and build

  • Run build runner

    dart run build_runner build

  • Run formatter and linter

    dart format .
dart fix --apply

Testing

  • You can perform the test manually by running the command below.

    dart run lib/main.dart

  • Try adding arguments.

    dart run lib/main.dart --version

LICENSE

For details see LICENSE.