x-twitter-scraper-cli

Xquik CLI: Twitter Search, Followers & X Automation

Use the Xquik CLI for Twitter search, profile tweets, user lookup, and follower exports. Download media, monitor X, manage webhooks, and run X automation from a terminal. It wraps the Xquik REST API as a command-line Twitter API alternative.

Stainless generates this CLI.

Choose the CLI

Use it for terminals, shell scripts, and one-off automation. Choose an SDK for long-running apps or custom error handling. Run --help before scripting generated commands and flags.

Installation

Install With Go

Install Go 1.22 or later.

go install 'github.com/Xquik-dev/x-twitter-scraper-cli/cmd/x-twitter-scraper@latest'

Go writes the binary to $GOBIN or $(go env GOPATH)/bin. If the command is unavailable, add that directory to PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

Run Locally

Run ./scripts/run args... from the cloned repository.

Usage

The CLI follows a resource-based command structure:

x-twitter-scraper [resource] <command> [flags...]

x-twitter-scraper x:tweets search \
  --api-key 'My API Key' \
  --q from:elonmusk \
  --limit 10

Common Commands

Run each command with --help before adding flags.

Environment Variables

Global Flags

• --api-key: Set the Xquik API key.
• --bearer-token: Set an OAuth 2.1 access token.
• --help: Show command-line usage.
• --debug: Include HTTP request & response details in logs.
• --version, -v: Show the CLI version.
• --base-url: Use a custom API base URL.
• --format: Set the output format.
• --format-error: Set the error format.
• --transform: Filter output with GJSON syntax.
• --transform-error: Filter errors with GJSON syntax.

Credential flags also read their matching environment variables. Debug logs may contain private response data. Do not share them.

Passing Files as Arguments

Prefix a path with @ to send its contents:

x-twitter-scraper <command> --arg @abe.jpg

Use file references inside JSON or YAML:

x-twitter-scraper <command> --arg '{image: "@abe.jpg"}'
# Equivalent:
x-twitter-scraper <command> <<YAML
arg:
  image: "@abe.jpg"
YAML

Escape a leading @ when sending a literal value:

x-twitter-scraper <command> --username '\@abe'

Explicit Encoding

JSON endpoints detect text and binary files. Use @file:// for text, @data:// for base64, and 3 slashes for absolute paths.

x-twitter-scraper <command> --arg @data://file.txt

Link Another Go SDK Version

Use ./scripts/link to test another Xquik Go SDK version:

./scripts/link github.com/org/repo@version
./scripts/link ../path/to/xtwitterscraper-go

Without an argument, the script uses ../x-twitter-scraper-go.

Support & Policies

• Organization support policy
• Security policy
• Contribution guide

Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.