LinkPeer Admin CLI (@linkpeer/admin)

LinkPeer Admin CLI is the official command-line administration tool for managing the LinkPeer platform. Built with Spring Boot 3 and Picocli in Java, and wrapped as a global NPM package, it provides administrators with real-time command-line and interactive REPL shell capabilities to manage users, verify faculty credentials, inspect analytics, handle payments, and control platform content.

⚡ Quick Start (Zero Configuration Required)

1. Install globally via NPM

npm install -g @linkpeer/admin

2. Run the CLI & Log In

Simply run linkpeer from any terminal to launch the interactive administration shell:

linkpeer

  _      _       _    _____               
 | |    (_)     | |  |  __ \              
 | |     _ _ __ | | _| |__) |__  ___ _ __ 
 | |    | | '_ \| |/ /  ___/ _ \/ _ \ '__|
 | |____| | | | |   <| |  |  __/  __/ |   
 |______|_|_| |_|_|\_\|_|   \___|\___|_|   
                                          
          ADMINISTRATION CLI              

🔐 Authentication Required. Please log in.
Email: [email protected]
Password: *********

✓ Login successful!

linkpeer> dashboard

(Or log in explicitly via linkpeer login).

🏗️ Architecture

LinkPeer Admin CLI uses a hybrid NPM + Java architecture to combine the simplicity of npm install -g with the high-performance backend power of Java & Spring Boot:

User executes:
  linkpeer analytics dashboard
       │
       ▼
NPM Global Command Bin
       │
       ▼
Node.js Launcher Wrapper (bin/linkpeer.js)
       │
       ▼
Executes: java -jar lib/linkpeer-admin-cli.jar analytics dashboard
       │
       ▼
Spring Boot 3 + Picocli Engine (Auto-connects to Database & Executes Command)

⚡ Prerequisites

To install and run LinkPeer Admin CLI, your environment needs:

1. Java Runtime Environment (JRE/JDK): Java 21 or higher installed and available in your system PATH.
   • Verify with: java -version
2. Node.js: Node.js 18 or higher.
   • Verify with: node -v

⚙️ Optional Environment Overrides

The CLI automatically connects to the LinkPeer database out of the box with zero manual configuration.

If you wish to override the database connection for local development or staging, you can place a .env file in your current working directory or in ~/.linkpeer/.env:

SUPABASE_DB_URL=jdbc:postgresql://custom-host:6543/postgres?sslmode=require&prepareThreshold=0&preferQueryMode=simple
SUPABASE_DB_USERNAME=custom_user
SUPABASE_DB_PASSWORD=custom_password

🛠️ Commands Reference Summary

| Command Category | Command | Description | Example | |---|---|---|---| | Authentication | login | Interactive admin authentication | linkpeer login | | | logout | End session & clear stored session token | linkpeer logout | | | whoami | Show currently authenticated admin details | linkpeer whoami | | Analytics | dashboard | Display high-level metrics & platform activity | linkpeer dashboard | | | analytics top-users | View top users ranked by engagement score | linkpeer analytics top-users | | | analytics activity <userId>| View chronological activity logs for a user | linkpeer analytics activity <id> | | User Management | users list | Tabular list of platform users | linkpeer users list | | | users view <userId> | Detailed profile & faculty verification data | linkpeer users view <id> | | | users search <keyword> | Search users by name, email, or department | linkpeer users search John | | | users verify <userId> | Manually verify user status | linkpeer users verify <id> | | Faculty Requests | faculty pending | List pending faculty verification claims | linkpeer faculty pending | | | faculty approve <userId>| Approve a faculty verification request | linkpeer faculty approve <id> | | | faculty reject <userId> | Reject a faculty request with reason | linkpeer faculty reject <id> "Invalid ID" | | Content Management| posts list | List posts created on the platform | linkpeer posts list | | | posts delete <postId> | Delete post and cascading comments/likes | linkpeer posts delete 42 | | | comments list | View platform comments with like counts | linkpeer comments list | | Notices & Broadcasts| notices list | List platform notices | linkpeer notices list | | | broadcasts send | Send system-wide broadcast notification | linkpeer broadcasts send "Alert" "Body" | | Subscriptions | subs active | View active user subscriptions | linkpeer subs active | | | subs extend <userId> <days>| Extend user subscription duration | linkpeer subs extend <id> 30 | | Payments | payments recent | View 50 most recent payment transactions | linkpeer payments recent | | Data Exports | export users | Export user table data to CSV file | linkpeer export users |

💻 Development & Publishing Guide

Build locally

npm run build

Test locally

npm install -g .

Release a new version to NPM

npm version patch
npm publish --access public

📄 License

ISC License © LinkPeer Team.