Skip to content

Installation.md

Latest commit

 

History

History
43 lines (32 loc) · 1.42 KB

Installation.md

File metadata and controls

43 lines (32 loc) · 1.42 KB

Installation

Prerequisites

To use HPort, you need to have the following installed and configured:

  1. Hetzner Cloud Account:

    • You must have an active Hetzner Cloud account.
    • Generate an API Token in the Hetzner Cloud Console under your project's "Security" > "API Tokens" tab.
    • Ensure you have an SSH Key added to your project. You will need the ID of this key to provision servers that you can access via SSH (though HPort handles most management for you).

  2. .NET 9.0 SDK:

  3. Git (Optional):

    • Required if you intend to clone the repository and build from source.

Building from Source

Currently, HPort is distributed as source code. Follow these steps to build the CLI tool:

  1. Clone the Repository:

    git clone https://github.com/ItsNameless/hport.git
cd hport

  2. Build the Solution:

    dotnet build -c Release

  3. Run the CLI: You can run the CLI directly using dotnet run:

    dotnet run --project src/ItsNameless.HPortCli -- [command]

    Alternatively, you can publish it as a standalone executable:

    dotnet publish src/ItsNameless.HPortCli -c Release -o ./publish
./publish/hport [command]