utility-client

Utility Client Manual

Utility Client is a versatile command-line tool designed to manage Utility Server’s operations, including configuration management, client onboarding, caching, logging, and system monitoring. It supports both standard CLI and an interactive shell mode.

For more details, check out our Knowledge Base.

---

Table of Contents

1. Installation
2. Execution Modes
3. Configuration
4. Client Management
5. Cache Management
6. Log Management
7. User & Security Operations
8. Statistics & Plans
9. Session Management
10. Miscellaneous
11. Command Reference

---

Installation

On Linux (Ubuntu/Debian-based)

$ wget https://github.com/utility-server/utility-client/raw/main/UtilityClient-Debin-amd64-latest.deb
$ sudo dpkg -i UtilityClient-Debin-amd64-latest.deb

---

Execution Modes

Utility Client supports two modes:

1. Standard CLI Mode

Run commands prefixed with a dash (-) like:

$ utility-client -login

2. Interactive Shell Mode

Enter by typing:

$ utility-client

You will see a prompt like:

֎ [CLIENT_ID] MODULE %

Run commands without the dash in this mode:

֎ demoClient default % login

---

Configuration

Set Configuration

$ utility-client -setConfig

Prompts for:

• Registered Domain
• Client ID
• End Point
• Access Key
• Client Secret
• Sitemap URL
• Concurrent Threads

View Configuration

$ utility-client -printConfig

Reload Server Cache Configuration

$ utility-client -reloadMyConf

---

Client Management (Only for Admins and Resellers)

List Clients

$ utility-client -listClients

Lists all configured clients under the current session.

Load Client Configuration

$ utility-client -loadClient=<LIST | CLIENT ID>

Loads configuration for a selected client.

Onboard New Client

$ utility-client -onboardClient

Starts the interactive onboarding process for new clients.

Assign New Plan to Client

$ utility-client -assignNewPlan

Assigns a billing or usage plan to a selected client.

---

Cache Management

Purge All Cache

$ utility-client -purgeAllCache

Removes all cached data for the active client.

Purge Specific URL Cache

$ utility-client -purgeURLCache <URI | ./path/to/URLlist>

Purges cache for a specific URL or batch list.

Update Cache TTL

$ utility-client -updateTTL=<TTL>

Sets TTL (time-to-live) for cached content. Value is in days.

Warmup Cache

$ utility-client -warmupCache [./path/to/URLlist]

Prefetches resources to warm up the cache.

---

Log Management

Download Log Report

$ utility-client -downloadLogReport

Downloads compressed logs for review.

Fetch Live Logs

$ utility-client -fetchLiveLogs

Streams live logs from Utility Server.

---

User & Security Operations

Activate Account

$ utility-client -activateAccount

Activates a user account using their registered email.

Login

$ utility-client -login

Prompts user login with credential validation.

Logout

$ utility-client -logout

Ends the current session.

Reset Password

$ utility-client -resetPassword

Initiates password reset by sending email.

Push Access Key / Secret Key

$ utility-client -pushAccessKey
$ utility-client -pushSecretKey

Pushes a new access or secret key for secured requests.

Rotate Access Key / Secret Key

$ utility-client -rotateAccessKey
$ utility-client -rotateSecretKey

Replaces current keys with new ones.

Whitelist IPs

$ utility-client -whitelistIPs <IPV4 IPV6 ...>

Adds IPs to the whitelist for client access.

---

Statistics & Plans

Fetch Statistics by Month

$ utility-client -getStats=<MONTH>

Returns usage reports for a given month.

Show Available Plans

$ utility-client -showPlans

Lists all available plans and their limits.

---

Session Management

Validate Transaction

$ utility-client -validateTxn=<transaction>

Validates a transaction ID from logs or API.

Who Am I (Current Logged-in User)

$ utility-client -whoami

Displays the current logged-in user identity.

Terminate All Sessions

$ utility-client -terminateSession

Closes all active sessions under this user.

---

Miscellaneous

Help

$ utility-client -help

Prints help details.

Version

$ utility-client -ver

Shows the Utility Client version installed.

Update (Requires sudo)

$ sudo utility-client -update

Installs the latest version of Utility Client.

History (Interactive Mode Only)

history

Shows previously executed commands.

Clear History (Interactive Mode Only)

clearHistory

Clears command history.

View Orders

$ utility-client -myOrders

Displays confirmed service or billing orders.

Set Active Module

$ utility-client -setActiveModule

Sets the currently focused module in interactive session.

Sitemap Operations

$ utility-client -sitemap <add|update|flush|get|delete>

Manages sitemap functions for client websites.

---

Command Reference

Command	Description
-activateAccount	Activate an account using email ID
-assignNewPlan	Assign a new plan to a client
-clearHistory	Clear all historical commands (interactive)
-downloadLogReport	Download log reports
-fetchLiveLogs	Fetch live system logs
-getStats=	Retrieve monthly stats
-help	Show help info
-history	Show past commands (interactive only)
-listClients	List all configured clients
-loadClient=<…>	Load or switch to a specific client
-login	Login to your account
-logout	Logout from current session
-myOrders	View your confirmed orders
-onboardClient	Start onboarding a new client
-printConfig	Display current config
-purgeAllCache	Clear all cache data
-purgeURLCache	Purge specific URLs from cache
-pushAccessKey	Set a new access key
-pushSecretKey	Set a new secret key
-reloadMyConf	Reload cached configs
-resetPassword	Trigger password reset
-rotateAccessKey	Rotate access key
-rotateSecretKey	Rotate secret key
-setActiveModule	Set the active module
-setConfig	Configure Utility Client
-showPlans	List available plans
-sitemap	Manage sitemap (Add, Update, Flush, etc.)
-terminateSession	End all active sessions
-update	Update Utility Client (requires sudo)
-updateTTL=	Set TTL for cached entries
-validateTxn=	Validate a transaction ID
-ver	Display Utility Client version
-warmupCache	Prefetch & warm cache
-whitelistIPs	Whitelist IPs for access
-whoami	Show current logged-in user