Basic Commands

Basic Commands

# Check version
koneksi version

# Health check
koneksi health

Authentication

# Login with credentials
koneksi auth login --email [e-mail] --password yourpassword 

# Logout
koneksi auth logout --email [e-mail]

Backup & Recovery Scenario

Backup Operations

1. File Upload

# Upload file
koneksi file upload --file-path /path/to/file.txt --email [e-mail]

1. Folder Upload

# Upload directory
koneksi directory upload --path /path/to/directory --email [e-mail]

1. Real-time backups

# Add realtime backup location
koneksi realtime-backup path add --path /path/to/directory --email [e-mail]

# Verify current backup location
koneksi realtime-backup path read --email [e-mail]

# Start initial backup
koneksi realtime-backup realtime start --email [e-mail]

# Start watcher to detect backup location changes
koneksi realtime-backup watcher start --email [e-mail]

# List realtime backup queue to check in-progress / pending uploads
koneksi realtime-backup queues read --email [e-mail]

# Stop watcher to disable backup location changes detection
koneksi realtime-backup watcher stop --email [e-mail]

# Remove realtime backup location
koneksi realtime-backup path remove --email [e-mail]

Verify Backups

# List root directory content
koneksi directory read --email [e-mail]

# List specific directory content
koneksi directory read --directory-id 6899f1bbdafb251035d62d67 --email [e-mail]

Recovery Operations

# Create recovery request (it will start the initial recovery process)
koneksi recovery request --path /path/to/recovery-path --scope full --email [e-mail]

# List recovery requests (view recovery requests history)
koneksi recovery list --email [e-mail]

# List recovery request queue items (view all pending files to recover)
koneksi recovery list-queue --recovery-id 6899e7cedafb251035d62d66 --email [e-mail]

# Process recovery queue (if recovery fails, we can use this to retry)
koneksi recovery process-queue --recovery-id 6899e7cedafb251035d62d66 --email [e-mail]

# Delete recovery request (force stop ongoing recovery or remove recovery request from history)
koneksi recovery delete --recovery-id 6899e7cedafb251035d62d66 --email [e-mail]

Engine Service Monitoring

Monitor logs:

# Linux/macOS
tail -f koneksi-engine/koneksi-engine.log

# Windows
//cmd
type koneksi-engine\koneksi-engine.log

// powershell
Get-Content .\koneksi-engine\koneksi-engine.log -Wait

Check process status:

# Linux/macOS
ps aux | grep koneksi

# Windows
// cmd
tasklist | findstr /i koneksi

// powershell
Get-Process | Where-Object { $_.Name -like "*koneksi*" } | Select-Object Name, Id, CPU, WorkingSet

Email Storage Feature

The Koneksi CLI now supports storing your email address locally so you don't need to provide it with every command. This feature improves user experience by reducing repetitive input.

How It Works

The CLI stores your email address in a configuration file located at:

• Windows: %USERPROFILE%\.koneksi\user.json

• macOS/Linux: ~/.koneksi/user.json

Commands

Set Your Email

• This command saves your email address to the local configuration file.

koneksi config set --email "[e-mail]"

Show Stored Email

• This command displays the currently stored email address.

koneksi config show

Clear Stored Email

• This command removes the stored email address from the configuration file.

koneksi config clear

Usage

# Set email once
koneksi config set --email "[e-mail]"

# Use commands without --email flag
koneksi profile get
koneksi admin organizations list
koneksi files list

# Or still use --email flag to override stored email
koneksi profile get --email "[e-mail]"

Priority Order

When a command requires an email address, the CLI follows this priority:

1. Command line flag (--email) - highest priority

2. Stored configuration - fallback if no flag provided

3. Error message - if neither is available

Error Handling

If no email is provided via flag or stored configuration, you'll see a helpful error message:

Error: no email provided. Use --email flag or run 'koneksi config set' first

To set your email for future use, run:
  koneksi config set --email "[e-mail]"

Security

• The email is stored locally on your machine

• The configuration file uses standard file permissions (644)

• No sensitive data (passwords, tokens) is stored in this file

• You can clear the stored email at any time

Migration

Existing commands that require --email flag will continue to work as before. The new system is backward compatible.

Configuration File Format

The configuration file (user.json) has this structure:

{
  "email": "[e-mail]"
}

Future versions may include additional user preferences in this file.

Troubleshooting

Email Not Being Used

• Check if email is stored: koneksi config show

• Verify the stored email is correct

• Try setting it again: koneksi config set --email "[e-mail]"

Configuration File Issues

• The file is created automatically in ~/.koneksi/user.json

• If the file is corrupted, delete it and set your email again

• Check file permissions if you encounter access issues

Multiple Users

• Each user account on the system has their own configuration file

• The email is stored per-user, not globally