Getting Started

To get started, you need to create a Koneksi account and verify.

Web Application

Access the Web Application

1. Access the Koneksi Web Application here.

Account Registration

1. Launch the Web Application

2. Click on the 'Create an Account' link below the login button

1. You will then be redirected to the Create Account form. Input all the necessary details needed then hit the 'Create Account' button to proceed.

1. After you create an account, a verification email will be sent to your email.

Account Verification

1. Open the verification email

2. Enter the verification code on the 'Verify Your Email' screen then hit the 'Verify Email' button

1. Your account will now be marked as Verified in the system. Once verified, you will then be redirected to the Koneksi Backup File Explorer page.

   1. Unverified users have limited access until verification is complete.

Once you're done creating your account, you can explore the Web Application features here.

Desktop App

Installation

1. Download the Koneksi Desktop app installer here.

2. Install the app on your machine

   1. For Mac Users, you will encounter app is damaged notification on your machine, this is because the app isn't code signed yet. We can bypass the code sign error by running sudo xattr -rd com.apple.quarantine <path/to/application.app> on the terminal.

   2. Hit 'Enter' then input your password

   3. Hit 'Enter again

   

   d. For Windows users, you should be able to install the app without any issues

Account Registration

1. Launch the Koneksi Desktop App

2. Click on the 'Create an Account' link below the login button

1. You will then be redirected to the Create Account form. Input all the necessary details needed then hit the 'Create Account' button to proceed.

1. After you create an account, a verification email will be sent to your email.

Account Verification

1. Open the verification email

2. Enter the verification code on the 'Verify Your Email' screen then hit the 'Verify Email' button

1. Your account will now be marked as Verified in the system. Once verified, you will then be redirected to the Koneksi Backup File Explorer page.

   1. Unverified users have limited access until verification is complete.

Once you're done creating your account, you can explore the Desktop Application features here.

Unified CLI tool

Installation

To start using CLI you have to install the Koneksi Desktop App first. Follow the App Installation instructions provided here.

The Koneksi CLI should be automatically installed when you install the Koneksi Desktop application.

After installation:

1. For Windows:

   1. you can run the command using the command koneksi in the Command Prompt or Powershell window.

2. For MacOS:

   1. the CLI is automatically installed to /users/<your-profile>/bin/koneksi/. This means you can run it from any terminal window by simply typing koneksi

If you encounter any issues, refer to the Troubleshooting section at the end of this page.

Using the CLI

1. After installing the Koneksi Desktop App, open terminal.

   1. For Mac:

      1. Press the Command (⌘) key and the Spacebar simultaneously to open Spotlight.2. Type "terminal" and press Enter or Return.

   2. For Windows:

      1. Click the Start button and Type "Terminal"

      2. Select the "Windows Terminal/Command Prompt" app.

In this guide, I will be using Windows Command Prompt as my terminal

2. Type in koneksi and press Enter. Then you will see the CLI help information as seen below.

koneksi

Example Output

Koneksi CLI

USAGE:
  koneksi [command] [flags]

COMMANDS:
  auth            Authentication related commands
  completion      Generate the autocompletion script for the specified shell
  dashboard       Access dashboard features and analytics
  directory       Directory management commands
  file            Manage files
  health          Check the health status of the Koneksi API
  help            Get help with Koneksi CLI commands
  peers           Manage peers
  profile         Profile-related commands
  service-account Service-Account related commands
  settings        Manage account and application settings
  version         Print the version information

Get detailed help:
  koneksi help [command]

3. You can now start using CLI commands with your terminal!

Account Registration

1. To register an account you can type:

koneksi auth register --first-name "Your First Name" --last-name "Your Last Name" --email "[e-mail]" --password "yourpassword" --confirm-password "yourpassword"

Example Output

[INFO] Sending registration request...
[SUCCESS] Status Code<200>: user registered successfully

1. Make sure to change the flag values with your actual details.

2. After changing values with your details, just press Enter to register.

3. After you create an account, a verification email will be sent to your email.

Request Token

1. Before going in to account verification, you will need your access token. You can request a token with this command:

koneksi auth login --email "[e-mail]" --password "yourpassword"

1. Make sure to save your access token by copying and pasting onto your notepad.

[INFO] Sending login request...
[SUCCESS] Status Code<200>: token requested successfully

=== Authentication Tokens ===
[INFO] Your authentication tokens have been received successfully.
[INFO] Please save these tokens securely for future API requests:
[INFO] ACCESS TOKEN:
<AccessToken>

[INFO] REFRESH TOKEN:
<RefreshToken>

[INFO] To use these tokens in API requests, include the access token in your Authorization header:
[INFO] Authorization: Bearer <access-token>

Account Verification

1. Open the verification email.

2. Verify your account using the following command:

koneksi auth verify-account --email "[e-mail]" --code "123456"

1. Don't forget to change the flag values with your actual email, code and access token.

[INFO] Verifying account...
[SUCCESS] Status Code<200>: account verified successfully
[INFO] Your account has been successfully verified!

1. Your account will now be marked as Verified in the system.

Once you're done creating your account, you can explore the Command-Line Interface features here.

Troubleshooting

For Windows

If you cannot run the koneksi command, try the following steps:

1. Restart your terminal: After installing Koneksi Desktop, you may need to restart any open Command Prompt or PowerShell windows to refresh the PATH.

2. Check if CLI is in your PATH: Run the following command to verify if the CLI installation directory is in your PATH:

echo %PATH%

You should see C:\Program Files\Koneksi\bin in the output.

1. Manual PATH addition: If the CLI directory is not in your PATH, you can add it manually:

# Run PowerShell as Administrator
$cliDir = "C:\Program Files\Koneksi\bin"
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";" + $cliDir, "Machine")

After running the command, restart your terminal.

1. Direct Access: If you cannot modify your PATH, you can access the CLI directly:

"C:\Program Files\Koneksi\bin\koneksi.exe"

Or find the CLI in the application resources folder:

"%LOCALAPPDATA%\Programs\koneksi-desktop\resources\bin\koneksi-cli-windows-amd64.exe"

For MacOS

If you cannot run the CLI command, try the following:

1. Restart your terminal completely

2. Reload your shell configuration:

source ~/.zshrc

1. Manual access: If needed, access the CLI directly from the app resources:

/Applications/koneksi-desktop.app/Contents/Resources/bin/koneksi-cli-darwin-arm64

Auth CLI tool

Use our authentication command-line tool, follow the instructions here.