chore: documentation updates

Author: algirdasci

.goreleaser.yaml

@@ -1,5 +1,18 @@
 project_name: hapi
 version: 2
+builds:
+  - main: ./main.go
+    env:
+      - CGO_ENABLED=0
+      - GO111MODULE=on
+    flags:
+      - -mod=vendor
+      - -v
+    goos:
+      - windows
+      - darwin
+      - linux
+
 archives:
   - name_template: "hapi-{{ .Version }}-{{ .Os }}-{{ .Arch }}"
     format_overrides:

AUTOCOMPLETE.md

@@ -0,0 +1,54 @@
+# Enabling shell auto-completion
+
+`hapi` has auto-complete support. This makes it easier to use the CLI and improves user experience by completing command
+names by clicking TAB key. For example if you type `hapi vps dat<TAB>` with auto-completion enabled, shell will automatically append
+rest of the command: `hapi vps data-centers`.
+
+Auto-completion can be generated for multiple shells. The currently supported shells are:
+- Bash
+- Zsh
+- fish
+- PowerShell
+
+After adding shell auto-completion, remember to refresh your shell profile by logging out from the shell and log back in.
+
+## Bash
+### Linux:
+```bash
+hapi completion bash > /etc/bash_completion.d/hapi
+````
+### macOS:
+```bash
+myapp completion bash > /usr/local/etc/bash_completion.d/hapi
+```
+
+## Zsh
+If shell completion is not already enabled in your environment, you will need to enable it.  You can execute the following once:
+```bash
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+```
+
+To load completions for each session, execute once:
+```bash
+hapi completion zsh > "${fpath[1]}/_hapi"
+```
+You will need to start a new shell for this setup to take effect.
+
+## Fish
+```bash
+hapi completion fish | source
+```
+To load completions for each session, execute once:
+```bash
+hapi completion fish > ~/.config/fish/completions/hapi.fish
+```
+
+## PowerShell
+```powershell
+hapi completion powershell | Out-String | Invoke-Expression
+```
+To load completions for every new session, run:
+```powershell
+hapi completion powershell > hapi.ps1
+```
+and source this file from your PowerShell profile.

README.md

@@ -0,0 +1,68 @@
+# Hostinger API Command Line Interface
+
+A powerful command-line interface for managing Hostinger services through the Hostinger API.
+
+For more information, please visit https://developers.hostinger.com.
+
+# Installation
+
+## Downloading a Release from GitHub
+Download the latest binary from the [releases page](https://github.com/hostinger/api-cli/releases).
+
+### Linux
+
+Download, extract and move the binary:
+```bash
+cd ~
+wget https://github.com/hostinger/api-cli/releases/download/<version>/hapi-<version>-linux-<arch>.tar.gz
+tar xf ~/hapi-<version>-linux-<arch>.tar.gz
+mv hapi /usr/local/bin
+```
+
+### macOS
+WIP
+
+### Windows
+WIP
+
+# Configuration
+
+## File
+Full example and possible values of the configuration file [can be found here](https://github.com/hostinger/api-cli/blob/main/hapi.yaml)
+
+By default, configuration file will be read from `$HOME/.hapi.yaml`.
+
+You can always define which configuration file to use by using `--config` argument, eg.: 
+```bash
+hapi --config path/to/your/config.yaml ...
+```
+
+## Environment variables
+Instead of providing configuration file, you can provide configuration using environment variables.
+Each config file property must have `HAPI_` prefix and key name in ALL CAPS, for example to provide
+`api_token` parameter, you would export variable like this:
+
+```bash
+export HAPI_API_TOKEN=<your token> 
+hapi vps vm list 
+```
+
+# Usage
+
+See the [full reference documentation](blob/main/docs/hapi.md) for information about each available command.
+
+# Enabling shell auto-completion (optional)
+
+`hapi` has auto-complete support. This makes it easier to use the CLI and improves user experience by completing command
+names by clicking TAB key. For example if you type `hapi vps dat<TAB>` with auto-completion enabled, shell will automatically append
+rest of the command: `hapi vps data-centers`.
+
+Auto-completion can be generated for multiple shells. The currently supported shells are:
+- Bash
+- Zsh
+- fish
+- PowerShell
+
+After adding shell auto-completion, remember to refresh your shell profile by logging out from the shell and log back in.
+
+Read more on [how to enable auto-completion](blob/main/AUTOCOMPLETE.md).

cmd/root.go

@@ -58,6 +58,7 @@ func initConfig() {
 		viper.SetConfigName(".hapi")
 	}
 
+	viper.SetEnvPrefix("hapi")
 	viper.AutomaticEnv() // read in environment variables that match
 	if err := viper.ReadInConfig(); err == nil {
 		fmt.Fprintln(os.Stderr, "Using config file:", viper.ConfigFileUsed())

docs/hapi.md

@@ -0,0 +1,16 @@
+## hapi
+
+Hostinger API Command Line Interface
+
+### Options
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+  -h, --help            help for hapi
+```
+
+### SEE ALSO
+
+* [hapi vps](hapi_vps.md)	 - VPS management
+

docs/hapi_vps.md

@@ -0,0 +1,33 @@
+## hapi vps
+
+VPS management
+
+### Options
+
+```
+  -h, --help   help for vps
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+```
+
+### SEE ALSO
+
+* [hapi](hapi.md)	 - Hostinger API Command Line Interface
+* [hapi vps actions](hapi_vps_actions.md)	 - VM actions information
+* [hapi vps backups](hapi_vps_backups.md)	 - VM backup management
+* [hapi vps data-centers](hapi_vps_data-centers.md)	 - Data center information
+* [hapi vps firewall](hapi_vps_firewall.md)	 - Firewall management
+* [hapi vps monarx](hapi_vps_monarx.md)	 - Malware scanner
+* [hapi vps post-install-scripts](hapi_vps_post-install-scripts.md)	 - Post-install script management
+* [hapi vps ptr](hapi_vps_ptr.md)	 - PTR records management
+* [hapi vps public-keys](hapi_vps_public-keys.md)	 - Public key management
+* [hapi vps recovery](hapi_vps_recovery.md)	 - Recovery mode management
+* [hapi vps snapshots](hapi_vps_snapshots.md)	 - Snapshot management
+* [hapi vps templates](hapi_vps_templates.md)	 - OS Templates
+* [hapi vps vm](hapi_vps_vm.md)	 - A brief description of your command
+

docs/hapi_vps_actions.md

@@ -0,0 +1,27 @@
+## hapi vps actions
+
+VM actions information
+
+### Synopsis
+
+Track and review operations performed on your virtual machines. These endpoints provide details about specific actions—such as start, stop, or restart—including timestamps and statuses.
+
+### Options
+
+```
+  -h, --help   help for actions
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+```
+
+### SEE ALSO
+
+* [hapi vps](hapi_vps.md)	 - VPS management
+* [hapi vps actions get](hapi_vps_actions_get.md)	 - Get action
+* [hapi vps actions list](hapi_vps_actions_list.md)	 - Get action list
+

docs/hapi_vps_actions_get.md

@@ -0,0 +1,30 @@
+## hapi vps actions get
+
+Get action
+
+### Synopsis
+
+This endpoint retrieves details of a specific action performed on a specified virtual machine.
+This endpoint allows you to view detailed information about a particular action, including the action name, timestamp, and status.
+
+```
+hapi vps actions get <virtual machine ID> <action ID> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for get
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+```
+
+### SEE ALSO
+
+* [hapi vps actions](hapi_vps_actions.md)	 - VM actions information
+

docs/hapi_vps_actions_list.md

@@ -0,0 +1,32 @@
+## hapi vps actions list
+
+Get action list
+
+### Synopsis
+
+Actions are operations or events that have been executed on the virtual machine, such as starting, stopping, 
+or modifying the machine. This endpoint allows you to view the history of these actions, providing details about each 
+action, such as the action name, timestamp, and status.
+
+```
+hapi vps actions list <virtual machine ID> [flags]
+```
+
+### Options
+
+```
+  -h, --help       help for list
+      --page int   Page number (default 1)
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+```
+
+### SEE ALSO
+
+* [hapi vps actions](hapi_vps_actions.md)	 - VM actions information
+

docs/hapi_vps_backups.md

@@ -0,0 +1,28 @@
+## hapi vps backups
+
+VM backup management
+
+### Synopsis
+
+Safeguard your data by managing backups. You can list available backups, restore a virtual machine from a backup, or delete backups as needed.
+
+### Options
+
+```
+  -h, --help   help for backups
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   Config file (default is $HOME/.hapi.yaml)
+      --format string   Output format type (json|table|tree), default: table
+```
+
+### SEE ALSO
+
+* [hapi vps](hapi_vps.md)	 - VPS management
+* [hapi vps backups delete](hapi_vps_backups_delete.md)	 - Delete backup
+* [hapi vps backups list](hapi_vps_backups_list.md)	 - Get backup list
+* [hapi vps backups restore](hapi_vps_backups_restore.md)	 - Restore backup
+