Complete Command Guide

The Koneksi CLI provides various commands for interacting with the engine and managing operations.

Koneksi CLI Command Reference

Overview

Koneksi CLI provides tools for interacting with the Koneksi API platform. This guide lists all available commands organized by functional category.

Config Commands

Command	Description
koneksi config set	Save a default email address to be used across CLI commands. This reduces the need to repeatedly specify --email.
koneksi config show	Display the currently stored default email configuration so you can confirm which account is active.
koneksi config clear	Remove the saved default email. Future commands will require --email explicitly until a new one is set. Useful when switching accounts.

Authentication Commands

Command	Description
koneksi auth register	Register a new user account by providing details such as name, email, and password.
koneksi auth verify-account	Verify a newly created account by confirming your email address. This step is required before login.
koneksi auth resend-verification	Resend a verification code to your email if the original was lost or expired.
koneksi auth login	Authenticate using your email and password to obtain access and refresh tokens for session management.
koneksi auth verify-otp	Provide a One-Time Password (OTP) to complete multi-factor authentication (MFA) during login.
koneksi auth forgot-password	Begin the password recovery process by requesting a reset code via email.
koneksi auth reset-password	Complete password recovery by supplying the reset code and creating a new password.
koneksi auth logout	Revoke all active refresh tokens for your account. This logs out all current sessions.

Settings Commands

Command	Description
koneksi settings change-password	Change your account password while logged in.
koneksi settings update-config	Update stored user settings such as preferences and defaults.
koneksi profile get	Retrieve and display details of your user profile, including email, role, and settings.

MFA Settings

Command	Description
koneksi settings mfa generate-otp	Generate a new OTP secret to set up MFA with an authenticator app.
koneksi settings mfa enable	Activate MFA for your account, adding an extra security layer.
koneksi settings mfa disable	Turn off MFA if you no longer want additional OTP verification.

Service Account Commands

Command	Description
koneksi service-account generate	Create a new service account and generate API credentials for it.
koneksi service-account browse	List all service accounts associated with your organization.
koneksi service-account revoke	Revoke or disable a service account, preventing further use.

Peer Connection Commands

Command	Description
koneksi peers fetch	Retrieve information about currently connected peers in the network cluster.

Directory Management Commands

Command	Description
koneksi directory create	Create a new directory in your storage
koneksi directory read	Display the contents of a directory, including files and subfolders.
koneksi directory update	Update a directory’s metadata (rename) or move it to another location.
koneksi directory delete	Permanently delete a directory and all of its contents.
koneksi directory upload	Upload an entire local folder (including its subfolders and files) into Koneksi storage.
koneksi directory get-queue	Show the list of directories currently in the upload queue. Useful for monitoring progress.
koneksi directory delete-queue	Cancel and remove a directory upload task from the queue.
koneksi directory retry-upload	Retry a failed directory upload task.
koneksi directory get-subdirectories	List all subdirectory IDs under a given parent directory.
koneksi directory move-multiple	Moves multiple directories with the specified host directory path
koneksi directory delete-multiple	Permanently deletes multiple directories

File Management Commands

Command	Description
koneksi file upload	Upload a single file into a specified directory.
koneksi file read	Retrieve detailed information about a file, including metadata
koneksi file update	Rename a file or move it between directories.
koneksi file delete	Permanently delete a file from storage.
koneksi file download	Download a file to your local system.
koneksi file get-shareable-url	Generate a persistent public URL for file sharing.
koneksi file generate-link	Generate a temporary time-bound download link for a file.
koneksi file share	Share a file directly with another user.
koneksi file move-multiple	Move multiple files into a target directory in one operation.
koneksi file delete-multiple	Delete multiple files permanently in bulk
koneksi file ipfs-upload	Upload a single file into a specified directory in IPFS.

Admin Commands

Command	Description
koneksi admin dashboard metrics	Retrieve and display system resource usage metrics from your Koneksi account
koneksi admin organizations list	List all organizations registered in the system.
koneksi admin organizations create	Create a new organization record.
koneksi admin organizations read	View details of a specific organization and its members.
koneksi admin organizations update	Edit an organization's information (at least one of name, domain, contact, or policy).
koneksi admin organizations add-member	Add a new member to an organization.
koneksi admin organizations update-member-role	Change a member’s role within an organization.
koneksi admin organizations remove-member	Remove a member from an organization
koneksi admin users list	List all users registered in the system
koneksi admin users create	Create a new user account as an admin.
koneksi admin users search	Search for a user by email
koneksi admin users read	Read user details by user ID
koneksi admin users update	Update user details by user ID
koneksi admin users update-limit	Adjust the storage quota/limit for a specific user.
koneksi admin realtime-backup list	List Realtime Backup in the system as an admin
koneksi admin realtime-backup read	Read Realtime Backup in the system as an admin
koneksi admin realtime-backup toggle	Enable or disable watcher in the system as an admin
koneksi admin realtime-backup delete	Delete Realtime Backup in the system as an admin
koneksi admin realtime-backup clear	Clear Realtime Backup in the system as an admin
koneksi admin recovery list	List Recovery Requests in the system as an admin
koneksi admin recovery read	Read Recovery Requests in the system as an admin
koneksi admin recovery approve	Approve Recovery Requests in the system as an admin
koneksi admin recovery reject	Reject Recovery Requests in the system as an admin

Organization Admin Commands

Command	Description
koneksi organization-admin dashboard metrics	View usage statistics and metrics for your organization.
koneksi organization-admin members search	Search for members within the organization by name or email.
koneksi organization-admin members create	Add a new member to the organization
koneksi organization-admin members update	Update member details, such as role or permissions.
koneksi organization-admin members read	View the details of a specific organization member.
koneksi organization-admin members remove	Remove a member from the organization
koneksi organization-admin members list	List all members in the organization
koneksi organization-admin organization read	Retrieve organization-level details and current members.
koneksi organization-admin organization update	Update your organization’s profile or configuration.
koneksi organization-admin realtime-backup list	List Organization Admin Realtime Backup
koneksi organization-admin realtime-backup read	Read Organization Admin Realtime Backup
koneksi organization-admin realtime-backup toggle	Toggle Organization Admin Watcher
koneksi organization-admin realtime-backup delete	Delete Organization Admin Realtime Backup
koneksi organization-admin realtime-backup clear	Clear Organization Admin Config Location
koneksi organization-admin recovery approve	Approve Recovery Requests in the system as an organization admin
koneksi organization-admin recovery list	List Recovery Requests in the system as an organization admin
koneksi organization-admin recovery read	Read Recovery Requests in the system as an organization admin
koneksi organization-admin recovery reject	Reject Recovery Requests in the system as an organization admin

Recovery Commands

Command	Description
koneksi recovery request	Submit a new recovery request.
koneksi recovery read	Retrieve the details of a specific recovery request.
koneksi recovery list	List all submitted recovery requests.
koneksi recovery delete	Cancel and delete a recovery request.
koneksi recovery process-queue	Process items in the recovery queue.
koneksi recovery update-request	Update the parameters of a recovery request.
koneksi recovery update-request-status	Change the status of a recovery request.
koneksi recovery list-queue	List all items currently in the recovery queue.
koneksi recovery delete-queue-item	Remove a specific item from the recovery queue.
koneksi recovery get-request-scope	Retrieve the scope or details of a recovery request.
koneksi recovery start	Start Recovery after admin has approved the Recovery Request.

Realtime-Backup Commands

Command	Description
koneksi realtime-backup directory stats	Show the file count and total storage size of a given directory.
koneksi realtime-backup path read	List all host directory paths currently tracked.
koneksi realtime-backup path remove	Remove a host directory path from realtime backup tracking.
koneksi realtime-backup queues read	Display the list of pending or ongoing realtime backup queues.
koneksi realtime-backup queues delete	Delete realtime backup queues.
koneksi realtime-backup queues retry	Retry uploading queue item.
koneksi realtime-backup realtime start	Start the realtime backup process for configured directories.
koneksi realtime-backup realtime sync	Synchronize realtime backups
koneksi realtime-backup watcher start	Launch the file system watcher that monitors changes and triggers backups.
koneksi realtime-backup watcher status	Check the current status of the watcher (running or stopped).
koneksi realtime-backup watcher stop	Stop the active watcher service.
koneksi realtime-backup config create	Create Realtime Backup Config.
koneksi realtime-backup config read	Read Realtime Backup Config.
koneksi realtime-backup config sync	Synchronize Realtime Backup Config.

Restore Point Commands

Command	Description
koneksi restore-points create	Creates a snapshot
koneksi restore-points list	List snapshots
koneksi restore-points read	Read snapshot
koneksi restore-points read-directory	Read snapshot directory
koneksi restore-points directory-scope	Snapshot directory scope
koneksi restore-points file-scope	Snapshot file scope

Dashboard Commands

Command	Description
koneksi dashboard metrics	Display overall system usage metrics such as storage usage, number of users, or file activity.

System Commands

Command	Description
koneksi health	Check the operational status of the Koneksi API server. Use --verbose for detailed diagnostics.

Help Command

Command	Description
koneksi help [command/category/category:command]	Display detailed help about a specific command, category, or the CLI in general.

Common Usage Examples

# Get help
koneksi help
koneksi help auth login

# Set the default email to be used when submitting commands
koneksi config set --email "[e-mail]"
koneksi config show
koneksi config clear

# Register a new user
koneksi auth register --first-name "John" --last-name "Doe" --email "[e-mail]" --password "SecurePass123!" --confirm-password "SecurePass123!"

# Login and authenticate
koneksi auth login --email "[e-mail]" --password "SecurePass123!"
koneksi auth verify-otp --email "[e-mail]" --login-code "ABC123DEF456" --otp "123456"
koneksi auth interactive-reset

# Manage files
koneksi file upload --file-path "/path/to/file.png" --directory-id "682aa5a96ef58914bf648be7"
koneksi file download --file-id "682aa5a96ef58914bf648be8" --output-path "./downloaded-file.png"
koneksi file generate-link --file-id "682aa5a96ef58914bf648be8" --email "[e-mail]" --duration 48
koneksi file share --file-id "682aa5a96ef58914bf648be8" --email "[e-mail]" --share-email "[e-mail]" --access read
koneksi file move-multiple --email "[e-mail]" --directory-id "68724f127d0d567ae10f58bd" --file-id "6872514c6d0ee8a367c7aa1d,6872514c6d0ee8a367c7aa1e"
koneksi file delete-multiple --email "[e-mail]" --file-id "6872514c6d0ee8a367c7aa1d,6872514c6d0ee8a367c7aa1e"
koneksi file ipfs-upload --filename "file.txt" --file-location "/path/to/local/directory" --directory-id "68412ab66364bcf0c7848ed0" --replace-existing --environment "local"

# Manage directories
koneksi directory create --name "My Documents" --parent-id "682aa5a96ef58914bf648be7"
koneksi directory read --directory-id "682aa5a96ef58914bf648be7"
koneksi directory upload --email "[e-mail]" --path "/path/to/local/directory" --directory-id "682aa5a96ef58914bf648be7"
koneksi directory get-upload-queue --directory-id "682aa5a96ef58914bf648be7"
koneksi directory delete-upload-queue --queue-id "682aa5a96ef58914bf648be8"
koneksi directory retry-upload --queue-id "682aa5a96ef58914bf648be8"
koneksi directory get-subdirectories
koneksi directory move-multiple --email "[e-mail]" --target-directory-id "68724f127d0d567ae10f58bd" --directory-ids "6872514c6d0ee8a367c7aa1d,6872514c6d0ee8a367c7aa1e"
koneksi directory delete-multiple --email "[e-mail]" --directory-ids "6872514c6d0ee8a367c7aa1d,6872514c6d0ee8a367c7aa1e"

# Manage recovery
koneksi recovery request --email "[e-mail]" --path "/recovery/path" --scope "full"
koneksi recovery read --email "[e-mail]" --request-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery list --email "[e-mail]" --page 1 --limit 10
koneksi recovery delete --email "[e-mail]" --recovery-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery process-queue --email "[e-mail]" --item-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery update-request --email "[e-mail]" --recovery-id "6872514c6d0ee8a367c7aa1d" --path "/recovery/path" --scope "point_in_time" --start-date "2021-01-01T00:00:00Z" --end-date "2021-01-02T23:59:59Z"
koneksi recovery update-request-status --email "[e-mail]" --recovery-id "6872514c6d0ee8a367c7aa1d" --status "in_progress"
koneksi recovery list-queue --email "[e-mail]" --recovery-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery delete-queue-item --email "[e-mail]" --item-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery get-request-scope --email "[e-mail]" --recovery-id "6872514c6d0ee8a367c7aa1d"
koneksi recovery start --email "[e-mail]" --request-id "6872514c6d0ee8a367c7aa1d"

# Manage Realtime Backup
koneksi realtime-backup directory stats --email "[e-mail]" --path "/recovery/path"
koneksi realtime-backup path read --email "[e-mail]"
koneksi realtime-backup path remove --email "[e-mail]" --path "/path/to/directory"
koneksi realtime-backup queue read --email "[e-mail]"
koneksi realtime-backup queues delete --email "[e-mail]" --queue-id "6872514c6d0ee8a367c7aa1d"
koneksi realtime-backup queue retry-upload --email "[e-mail]" --queue-id "6872514c6d0ee8a367c7aa1d"
koneksi realtime-backup realtime start --email "[e-mail]"
koneksi realtime-backup realtime sync --email "[e-mail]"
koneksi realtime-backup watcher start --email "[e-mail]"
koneksi realtime-backup watcher status --email "[e-mail]"
koneksi realtime-backup watcher stop --email "[e-mail]"
koneksi realtime-backup config read --email "[e-mail]"
koneksi realtime-backup config sync --email "[e-mail]"
koneksi realtime-backup config create --email "[e-mail]" --path "/path/to/directory"

# Manage Restore Points (Snapshots)
koneksi restore-points create --description "Test Description"
koneksi restore-points list --page 1 --limit 10
koneksi restore-points read --snapshot-id "6872514c6d0ee8a367c7aa1d"
koneksi restore-points read-directory --snapshot-id "6872514c6d0ee8a367c7aa1d" --directory-id "6872514c6d0ee8a367c7aa1d" --display
koneksi restore-points directory-scope --snapshot-id "6872514c6d0ee8a367c7aa1d" --page 1 --limit 10
koneksi restore-points file-scope --snapshot-id "6872514c6d0ee8a367c7aa1d" --page 1 --limit 10

# Check system status
koneksi health --verbose
koneksi health --diagnostic
koneksi health --verbose --diagnostic

Common Flags

Flag	Description
-e, --email	Your auth email address
-v, --verbose	Show detailed output
--help	Display help for a command