Skip to main content

Overview

The agntdata CLI (agnt_) provides quick access to social media data from your terminal. Useful for testing, scripting, and quick lookups without writing code.
The CLI package is currently in development and may not yet be published to npm.

Installation

Install the CLI globally via npm:
npm install -g @agntdata/cli
Or using pnpm:
pnpm add -g @agntdata/cli

Authentication

Interactive Login

The easiest way to authenticate:
agnt_ login
This opens your browser for authentication and stores your credentials in ~/.agntdata/config.json.

Check Authentication

Verify your authentication status:
agnt_ whoami

Logout

Clear your saved credentials:
agnt_ logout

Commands

List Available APIs

agnt_ apis
Shows all available platforms with their descriptions.
agnt_ apis --json
Output as JSON for scripting.

Make API Calls

Use the call command to make API requests:
agnt_ call <platform> <endpoint> [options]
Options:
OptionDescription
-q, --query <params>Query parameters (e.g., username=microsoft)
-d, --data <json>JSON body for POST requests
-m, --method <method>HTTP method (GET, POST, etc.)
--rawOutput raw response without formatting

Examples

# Get LinkedIn company details
agnt_ call linkedin /get-company-details -q username=microsoft

# Get YouTube channel info
agnt_ call youtube /get-channel-details -q username=@mkbhd

# Get X user profile
agnt_ call x /get-user-details -q username=elonmusk

Available Platforms

PlatformSlug
LinkedInlinkedin
YouTubeyoutube
TikToktiktok
X (Twitter)x
Instagraminstagram
Redditreddit
Facebookfacebook

Configuration

Credentials are stored in ~/.agntdata/config.json after running agnt_ login.

Next Steps

Quickstart

Learn the basics of agntdata.

API Reference

Browse all available endpoints.