x-twitter-scraper-cli

X API & Twitter API CLI by Xquik

Use this Twitter CLI & X CLI to work with X from a terminal. It works as a Twitter scraper & tweet scraper for search, profiles, followers & lists. Scrape Twitter timelines, communities & trends into JSON, YAML or an interactive view. Download media, monitor accounts, manage webhooks & run X automation from scripts. It is a Twitter API alternative built on the Xquik REST API.

Xquik is the world's fastest and cheapest X Twitter scraper service with the most complete X data. Xquik charges only for delivered, unique, filter-matching results and never pads rows.

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

Installation

Install with Go

Install Go 1.21 or later. Go downloads the toolchain this CLI needs.

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"

Download a release

Each GitHub release has archives for macOS, Linux & Windows. Linux users can also pick a .deb, .rpm, .apk or Arch Linux package. Compare each download with the release's checksums file.

From a cloned repository, run ./scripts/run args... instead.

Usage

The CLI follows a resource-based command structure.

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

This command returns 10 recent posts from 1 account.

x-twitter-scraper x:tweets search \
  --q from:elonmusk \
  --limit 10

Common commands

Run each command with --help before adding flags.

Environment variables

Global flags

• --api-key sets the Xquik API key.
• --bearer-token sets an OAuth 2.1 access token.
• --help shows command-line usage.
• --debug adds HTTP request & response details to logs.
• --version or -v shows the CLI version.
• --base-url sends requests to another API base URL.
• --format sets the output format.
• --format-error sets the error format.
• --transform filters output with GJSON syntax.
• --transform-error filters errors with GJSON syntax.
• --raw-output or -r prints a string result without JSON quotes.

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"}'
# The same input as YAML.
x-twitter-scraper <command> <<YAML
arg:
  image: "@abe.jpg"
YAML

Escape a leading @ when sending a literal value.

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

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

Test another Go SDK version

Pass a module version or local path to ./scripts/link.

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

The script defaults to ../x-twitter-scraper-go.

Checks & releases

Run bin/check-local before you open a pull request. It runs REUSE, lint, script tests, Go tests, coverage, govulncheck, 2 reproducible builds, fuzzing & CodeQL. It posts the result as the xquik-local-checks commit status. Maintainers publish releases from main with bin/release-local. bin/release-local --dry-run builds every release asset and publishes nothing.

More Xquik tools

• X (Twitter) scraper API & Twitter MCP server with REST, MCP & Skill setup.
• Twitter API SDKs for TypeScript, Python, Go, Ruby, Java, Kotlin, C# & PHP.
• Twitter advanced search operators with tested examples.
• Xquik X API & Twitter scraper and the Twitter API documentation.

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.