X Twitter Scraper CLI

https://github.com/xquik-dev/x-twitter-scraper-cli
Admin
A command-line interface for the X Twitter Scraper REST API that enables developers to search and...
Tokens:22,365
Snippets:343
Trust Score:5.5
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Input handling examples

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Examples demonstrating how to pass file inputs and base64 encoded data to commands.

```bash
x-twitter-scraper x:tweets create \
  --account myaccount \
  --text "Check this image:" \
  --media @image.jpg
```

```bash
x-twitter-scraper x:tweets create \
  --account myaccount \
  --text "Post with data:" \
  --media @data://binary-file.bin
```

--------------------------------

### Install Xquik CLI with Go

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Install the CLI binary using the Go toolchain.

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

--------------------------------

### Example YAML output

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Sample structure of the YAML output format.

```yaml
data:
  id: '123'
  text: Hello World
  author:
    id: '456'
    username: alice
```

--------------------------------

### Query Parameter Encoding Example

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/internal-modules.md

Example of URL query string formatting.

```text
?q=search+term&limit=10&ids=123,456,789
```

--------------------------------

### Example JSONL output

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Sample structure of the JSONL output format.

```json
{"id":"123","text":"Hello"}
{"id":"124","text":"World"}
{"id":"125","text":"Test"}
```

--------------------------------

### Write Binary Response Usage Example

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Demonstrates how to use writeBinaryResponse to handle media downloads with automatic destination detection.

```go
// Download media response, auto-detect destination
resp, _ := http.Get("https://example.com/image.jpg")
msg, err := writeBinaryResponse(resp, os.Stdout, "")
if err != nil {
    fmt.Printf("Write error: %v\n", err)
}
// Output: "Wrote output to image-abc123.jpg." (or stdout if text)
```

--------------------------------

### Example JSON output

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Sample structure of the JSON output format.

```json
{
  "data": {
    "id": "123",
    "text": "Hello World",
    "author": {
      "id": "456",
      "username": "alice"
    }
  }
}
```

--------------------------------

### File Input Handling Examples

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Demonstrates various file input prefixes including binary embedding, text files, base64 encoding, stdin, and escaping.

```bash
# Embed image in tweet
x-twitter-scraper x:tweets create --account myaccount --media @photo.jpg

# Embed text file
x-twitter-scraper x:tweets create --account myaccount --text @message.txt

# Base64-encoded binary data
x-twitter-scraper x:tweets create --account myaccount --media @data://binary.bin

# Read from stdin
echo "Hello World" | x-twitter-scraper x:tweets create --account myaccount --text @-

# Literal @-mention (escaped)
x-twitter-scraper x:tweets create --account myaccount --text "Reply to \@alice"
```

--------------------------------

### Basic CLI Usage Examples

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Common commands for configuring authentication, searching tweets, retrieving user profiles, creating tweets, and exploring JSON output.

```bash
# Set authentication
export X_TWITTER_SCRAPER_API_KEY="your-api-key"
export X_TWITTER_SCRAPER_BEARER_TOKEN="your-bearer-token"

# Search tweets
x-twitter-scraper x:tweets search --q "from:elonmusk" --limit 10

# Get user profile
x-twitter-scraper x:users retrieve --username alice

# Create tweet
x-twitter-scraper x:tweets create \
  --account myaccount \
  --text "Hello world" \
  --idempotency-key "unique-id"

# Interactive JSON explorer
x-twitter-scraper --format explore x:tweets retrieve --id 123
```

--------------------------------

### Get article preview

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves a preview for a specific article URL.

```bash
x-twitter-scraper x get-article --url <URL> [FLAGS]
```

--------------------------------

### Complex Data Input Examples

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Shows how to provide nested data structures using JSON flags, YAML via stdin, or embedded files.

```bash
x-twitter-scraper custom-endpoint --data '{"nested": {"field": "value"}}'
```

```bash
x-twitter-scraper custom-endpoint <<YAML
nested:
  field: value
YAML
```

```bash
x-twitter-scraper x:tweets create <<EOF
account: myaccount
text: See this image
media: @image.jpg
EOF
```

--------------------------------

### x get-article

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Get a specific article or URL preview.

```APIDOC
## x get-article

### Description
Get a specific article/URL preview.

### Usage
`x-twitter-scraper x get-article --url <URL> [FLAGS]`

### Flags
- **--url** (string) - Required - Article URL
```

--------------------------------

### CLI Usage for File Embedding

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Examples of using the media, text, and attachment flags via the CLI, including stdin support.

```bash
# Embed image (auto-detected)
x-twitter-scraper x:tweets create --media @photo.jpg

# Text file (UTF-8)
x-twitter-scraper x:tweets create --text @message.txt

# Binary with base64
x-twitter-scraper x:tweets create --attachment @data://binary.bin

# Read from stdin
cat photo.jpg | x-twitter-scraper x:tweets create --media @-
```

--------------------------------

### Structure CLI Commands with Request Flags

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Example of defining a CLI command using requestflag to map flags to request bodies and headers.

```go
var xTweetsCreate = cli.Command{
    Name:    "create",
    Usage:   "Create tweet",
    Flags: []cli.Flag{
        // Body fields
        &requestflag.Flag[string]{
            Name:     "account",
            Usage:    "X account (@username or account ID)",
            Required: true,
            BodyPath: "account",
        },
        // Header field
        &requestflag.Flag[string]{
            Name:       "idempotency-key",
            Required:   true,
            HeaderPath: "Idempotency-Key",
        },
        // Array field
        &requestflag.Flag[[]string]{
            Name:     "media",
            Usage:    "Array of public media URLs",
            BodyPath: "media",
        },
        // Optional string field
        &requestflag.Flag[string]{
            Name:     "text",
            Usage:    "Tweet text",
            BodyPath: "text",
        },
    },
    Action: handleXTweetsCreate,
}
```

--------------------------------

### Get notifications

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches notifications for the authenticated user.

```bash
x-twitter-scraper x get-notifications [FLAGS]
```

--------------------------------

### CLI Usage for FilePathValue

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Example of using a flag configured with FilePathValue to load a file automatically.

```bash
# Without @ prefix (file is loaded automatically)
x-twitter-scraper custom --attachment /path/to/file.txt
```

--------------------------------

### x:users retrieve-batch

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Get multiple user profiles by usernames or IDs.

```APIDOC
## x:users retrieve-batch

### Description
Get multiple user profiles by usernames or IDs.

### Usage
`x-twitter-scraper x:users retrieve-batch --usernames <USER1>,<USER2>... [FLAGS]`

### Flags
- **--usernames** (string) - Required - Comma-separated usernames (max 100)
```

--------------------------------

### x:users retrieve

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Get a single user profile by username or ID.

```APIDOC
## x:users retrieve

### Description
Get a single user profile by username or ID.

### Usage
`x-twitter-scraper x:users retrieve --username <USERNAME> [FLAGS]`

### Flags
- **--username** (string) - Required - X username (with or without @)

### Returns
User profile object with follower/following counts, bio, location, etc.
```

--------------------------------

### JSON Data Structure

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Example JSON structure used for piping data into the CLI.

```json
{
  "account": "myaccount",
  "text": "From JSON",
  "media": ["@photo.jpg"]
}
```

--------------------------------

### Example error message output

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Standard format for error messages including HTTP status and error details.

```text
GET "https://api.xquik.com/x/tweets/123": 404 Not Found
{
  "error": {
    "code": "not_found",
    "message": "Tweet not found"
  }
}
```

--------------------------------

### Implement Flag Validator

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Example of a validator function used for format flags to ensure input matches allowed values.

```go
Validator: func(format string) error {
    if !slices.Contains(OutputFormats, strings.ToLower(format)) {
        return fmt.Errorf("format must be one of: %s", 
            strings.Join(OutputFormats, ", "))
    }
    return nil
}
```

--------------------------------

### Persistent Authentication Script

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Example of a shell script that sets authentication environment variables before executing multiple CLI commands.

```bash
#!/bin/bash
set -e

export X_TWITTER_SCRAPER_API_KEY="${API_KEY}"
export X_TWITTER_SCRAPER_BEARER_TOKEN="${BEARER_TOKEN}"

# All subsequent commands use the environment variables
x-twitter-scraper account retrieve
x-twitter-scraper x:tweets search --q "test"
x-twitter-scraper x:users retrieve --username alice
```

--------------------------------

### Search Tweets Example

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Perform a search for tweets from a specific user with a result limit.

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

--------------------------------

### Initialize CLI Package

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Initializes the root command upon package load.

```go
func init() {
    Command = newCommand()
}
```

--------------------------------

### x:users retrieve-followers

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Get followers of a user with filtering.

```APIDOC
## x:users retrieve-followers

### Description
Get followers of a user with filtering.

### Usage
`x-twitter-scraper x:users retrieve-followers --username <USERNAME> [FLAGS]`

### Flags
- **--username** (string) - Required - X username
- **--min-followers** (int64) - Optional - Minimum follower count
- **--max-followers** (int64) - Optional - Maximum follower count
- **--min-following** (int64) - Optional - Minimum following count
- **--max-following** (int64) - Optional - Maximum following count
- **--min-statuses** (int64) - Optional - Minimum post count
- **--max-statuses** (int64) - Optional - Maximum post count
- **--min-account-age-days** (int64) - Optional - Minimum account age in days
- **--verified-only** (bool) - Optional - Only verified accounts
- **--has-location** (bool) - Optional - Only with location
- **--has-website** (bool) - Optional - Only with website
- **--location-contains** (string) - Optional - Location filter
- **--bio-contains** (string) - Optional - Bio term filter
- **--username-contains** (string) - Optional - Username substring
- **--page-size** (int64) - Optional - Profiles per page (20-200, default 200)
- **--cursor** (string) - Optional - Pagination cursor
```

--------------------------------

### Version and Help Flags

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Display CLI version information or command help.

```bash
--version, -v
```

```bash
--help, -h
```

--------------------------------

### Initialize CLI Entry Point

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

The main function serves as the executable entry point, invoking the run engine and handling the process exit code.

```go
func main() {
    exitCode := run(cmd.Command, os.Args, os.LookupEnv, os.Stderr)
    if exitCode != 0 {
        os.Exit(exitCode)
    }
}
```

--------------------------------

### Generate CLI help documentation

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Access help information for the main CLI or specific command namespaces.

```bash
x-twitter-scraper --help
x-twitter-scraper x:tweets --help
x-twitter-scraper x:tweets create --help
```

--------------------------------

### x:users retrieve-tweets

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Get tweets from a user's profile.

```APIDOC
## x:users retrieve-tweets

### Description
Get tweets from a user's profile.

### Usage
`x-twitter-scraper x:users retrieve-tweets --username <USERNAME> [FLAGS]`

### Flags
- **--username** (string) - Required - X username
- **--limit** (int64) - Optional - Maximum tweets to return
- **--cursor** (string) - Optional - Pagination cursor
```

--------------------------------

### x:users:follow create

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Follow a user.

```APIDOC
## x:users:follow create

### Description
Follow a user.

### Usage
`x-twitter-scraper x:users:follow create --account <ACCOUNT> --user-id <USER_ID> [FLAGS]`

### Flags
- **--account** (string) - Required - X account ID
- **--user-id** (string) - Required - User ID to follow
```

--------------------------------

### List External Dependencies

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

List of Go modules and versions required for the project.

```text
github.com/Xquik-dev/x-twitter-scraper-go v0.16.0  (API client SDK)
github.com/urfave/cli/v3 v3.11.0                   (CLI framework)
github.com/charmbracelet/bubbletea v1.3.10         (Terminal UI)
github.com/charmbracelet/bubbles v1.0.0            (UI components)
github.com/charmbracelet/lipgloss v1.1.0           (Styling)
github.com/tidwall/gjson v1.19.0                   (JSON querying)
github.com/tidwall/pretty v1.2.1                   (JSON formatting)
github.com/goccy/go-yaml v1.19.2                   (YAML parsing)
github.com/itchyny/json2yaml v0.1.5                (JSON/YAML conversion)
github.com/muesli/reflow v0.3.0                    (Text wrapping)
```

--------------------------------

### Build Default Request Options

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

This function in pkg/cmd/cmdutil.go constructs the standard request options applied to all API calls.

```go
func getDefaultRequestOptions(cmd *cli.Command) []option.RequestOption
```

--------------------------------

### Get trending topics

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves current trending topics, optionally filtered by WOEID.

```bash
x-twitter-scraper x get-trends [FLAGS]
```

--------------------------------

### Configure PATH for Go Binaries

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Add the Go binary directory to your system PATH if the command is not found.

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

--------------------------------

### Get tweet thread via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves the full conversation thread for a specific tweet.

```bash
x-twitter-scraper x:tweets get-thread --id <TWEET_ID> [FLAGS]
```

--------------------------------

### Link Local Go SDK Version

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Point the CLI to a specific version or local path of the Go SDK for testing.

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

--------------------------------

### Get tweet replies via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves reply tweets for a given tweet ID.

```bash
x-twitter-scraper x:tweets get-replies --id <TWEET_ID> [FLAGS]
```

--------------------------------

### Get tweet retweeters via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves profiles of users who retweeted a specific tweet.

```bash
x-twitter-scraper x:tweets get-retweeters --id <TWEET_ID> [FLAGS]
```

--------------------------------

### Execute CLI Command

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Runs the CLI command using the provided background context and arguments.

```go
if err := app.Run(context.Background(), args); err != nil {
    // ... error handling (see Step 5)
}
```

--------------------------------

### Get quote tweets via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves quote tweets associated with a specific tweet ID.

```bash
x-twitter-scraper x:tweets get-quotes --id <TWEET_ID> [FLAGS]
```

--------------------------------

### Run CLI from source

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Execute the CLI directly from the source directory using the provided run script.

```bash
./scripts/run x:tweets search --q "test"
```

--------------------------------

### Link alternative SDK versions

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Use the link script to point the CLI to a local SDK path or a specific remote repository version.

```bash
./scripts/link ../x-twitter-scraper-go  # Local path
./scripts/link github.com/org/repo@version  # Remote version
```

--------------------------------

### Manage keyword monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Commands for creating and listing keywords associated with a specific monitor.

```bash
x-twitter-scraper monitors:keywords create --monitor-id <MONITOR_ID> --keywords <KEYWORD1>,<KEYWORD2>... [FLAGS]
```

```bash
x-twitter-scraper monitors:keywords list --monitor-id <MONITOR_ID> [FLAGS]
```

--------------------------------

### Persistent Configuration via Shell Script

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Use a wrapper script to export environment variables and execute the CLI, bypassing the lack of native configuration file support.

```bash
#!/bin/bash
# ~/.local/bin/xquik
export X_TWITTER_SCRAPER_API_KEY="your-api-key"
export X_TWITTER_SCRAPER_BEARER_TOKEN="your-token"
exec x-twitter-scraper "$@"
```

--------------------------------

### Enable Debug Logging

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Log full HTTP request and response details for troubleshooting.

```bash
--debug
```

```bash
x-twitter-scraper --debug x:tweets search --q "test" 2>&1 | tee debug.log
```

--------------------------------

### Get tweet favoriters via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieves profiles of users who liked a specific tweet, with optional filtering flags.

```bash
x-twitter-scraper x:tweets get-favoriters --id <TWEET_ID> [FLAGS]
```

--------------------------------

### Prepare CLI for Autocomplete

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Disables flag validation recursively for the command tree to support shell completion.

```go
if slices.Contains(args, "__complete") {
    prepareForAutocomplete(app)
}
```

```go
func prepareForAutocomplete(cmd *cli.Command) {
    cmd.SkipFlagParsing = true
    for _, child := range cmd.Commands {
        prepareForAutocomplete(child)  // Recursive
    }
}
```

--------------------------------

### Configure Root Command Properties

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Configuration object for the root CLI command including name, usage, and error handling.

```go
return &cli.Command{
    Name:      "x-twitter-scraper",
    Usage:     "CLI for the x-twitter-scraper API",
    Suggest:   true,              // Enable did-you-mean suggestions
    Version:   Version,           // From version.go
    ErrWriter: &CommandErrorBuffer,
    // ... flags and commands
}
```

--------------------------------

### Run local evidence verification commands

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/OPENSSF.md

Executes the project's bootstrap, linting, testing, license verification, and vulnerability scanning tools.

```sh
./scripts/bootstrap
./scripts/lint
./scripts/test
uvx --from reuse==5.1.1 reuse lint
go run golang.org/x/vuln/cmd/govulncheck@v1.6.0 ./...
```

--------------------------------

### x:account:connections

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands for managing account connections.

```APIDOC
## x:account:connections create
Initiate account connection.

### Flags
- **Platform** - Optional
- **Credentials** - Optional

## x:account:connections list
List connected accounts.

### Flags
- **Pagination** - Optional

## x:account:connections delete
Remove account connection.

### Flags
- **--id** (string) - Optional
```

--------------------------------

### monitors create

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Create an account monitor to track changes.

```APIDOC
## monitors create

### Description
Create an account monitor to track changes.

### Usage
`x-twitter-scraper monitors create --account <ACCOUNT> [FLAGS]`

### Flags
- **--account** (string) - Required - Account ID to monitor
```

--------------------------------

### Manage account monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Commands for creating, retrieving, listing, updating, and deactivating account monitors.

```bash
x-twitter-scraper monitors create --account <ACCOUNT> [FLAGS]
```

```bash
x-twitter-scraper monitors retrieve --id <MONITOR_ID> [FLAGS]
```

```bash
x-twitter-scraper monitors list [FLAGS]
```

```bash
x-twitter-scraper monitors update --id <MONITOR_ID> [FLAGS]
```

```bash
x-twitter-scraper monitors deactivate --id <MONITOR_ID> [FLAGS]
```

--------------------------------

### Define search command flags with pagination

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Configures standard search parameters including a required query string, cursor, and limit.

```go
&requestflag.Flag[string]{
    Name:      "q",
    Required:  true,
    QueryPath: "q",
},
&requestflag.Flag[string]{
    Name:      "cursor",
    QueryPath: "cursor",
},
&requestflag.Flag[int64]{
    Name:      "limit",
    QueryPath: "limit",
},
```

--------------------------------

### Set X Username

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Configures the X username associated with the authenticated account.

```bash
x-twitter-scraper account set-x-username --username <USERNAME> [FLAGS]
```

--------------------------------

### x:accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands for managing X account details and settings.

```APIDOC
## x:accounts retrieve
Get X account details.

### Flags
- **--id** (string) - Optional
- **--username** (string) - Optional

## x:accounts list
List accessible accounts.

### Flags
- **Pagination** - Optional

## x:accounts update
Update account settings.

### Flags
- **--id** (string) - Optional
```

--------------------------------

### Manage webhooks

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Commands for creating, testing, listing, and viewing delivery attempts for webhooks.

```bash
x-twitter-scraper webhooks create --url <WEBHOOK_URL> --events <EVENT1>,<EVENT2>... [FLAGS]
```

```bash
x-twitter-scraper webhooks test --id <WEBHOOK_ID> [FLAGS]
```

```bash
x-twitter-scraper webhooks list [FLAGS]
```

```bash
x-twitter-scraper webhooks list-deliveries --id <WEBHOOK_ID> [FLAGS]
```

--------------------------------

### Define Version Constant

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

The version string is maintained in pkg/cmd/version.go and updated automatically by release-please.

```go
const Version = "0.13.3" // x-release-please-version
```

--------------------------------

### Retrieve Account Details

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches current account information, including balance and subscription status.

```bash
x-twitter-scraper account retrieve [FLAGS]
```

--------------------------------

### Define Global CLI Variables

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Global variables for the root command and error buffer management.

```go
var Command *cli.Command
```

```go
var CommandErrorBuffer bytes.Buffer
```

--------------------------------

### ShowJSON usage

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Displays JSON results with various formatting options, transformations, and output destinations.

```go
// Display a tweet object in interactive explore mode
tweetJSON := gjson.Parse(`{"id":"123","text":"Hello","likes":42}`)
ShowJSON(tweetJSON, ShowJSONOpts{
    Format: "explore",
    Title:  "Tweet Details",
    Transform: "data",
})

// Display with transformation and raw output
ShowJSON(tweetJSON, ShowJSONOpts{
    Format: "json",
    Transform: "text",
    RawOutput: true,
    Stdout: os.Stdout,
})
```

--------------------------------

### Generate Shell Completion Scripts

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/internal-modules.md

Commands to display completion instructions and initialize shell completion for bash.

```bash
x-twitter-scraper --help  # Shows completion instructions
eval "$(x-twitter-scraper completion bash)"  # Bash setup
```

--------------------------------

### Detect file extension from binary data

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Uses binary content to identify file types and return the corresponding extension. Returns .txt for UTF-8 text and .bin for unknown formats.

```go
func guessExtension(data []byte) string
```

```go
data, _ := os.ReadFile("downloaded-media")
ext := guessExtension(data)
filename := "download" + ext
// Output: "download.jpg" or "download.png" depending on content
```

--------------------------------

### Configure Data Aliases

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag with alternate names that can be mapped from stdin JSON keys.

```go
&requestflag.Flag[string]{
    Name:        "creator",
    BodyPath:    "account",
    DataAliases: []string{"account_id", "author"},
}
```

--------------------------------

### Configure Stream Input

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag using io.ReadCloser to stream large binary files instead of loading them into memory.

```go
&requestflag.Flag[io.ReadCloser]{
    Name:     "video",
    BodyPath: "video",
}
```

--------------------------------

### Global CLI Flags

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

List of available flags applicable to all commands for authentication, formatting, and debugging.

```text
--api-key <KEY>           API key for authentication
--bearer-token <TOKEN>    Bearer token (OAuth 2.1)
--base-url <URL>          Override API base URL
--format <FORMAT>         Output format (json, yaml, explore, etc.)
--format-error <FORMAT>   Error output format
--transform <GJSON_PATH>  Extract data with GJSON
--transform-error <PATH>  Extract errors with GJSON
--raw-output, -r          Print strings without JSON quotes
--debug                   Enable HTTP request/response logging
--help                    Show command help
--version                 Display version
```

--------------------------------

### CLI Command Structure

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

The general syntax for executing commands via the CLI.

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

--------------------------------

### CLI Command Structure

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

The base syntax for executing commands in the Xquik Twitter Scraper CLI.

```bash
x-twitter-scraper [GLOBAL_FLAGS] [RESOURCE] [COMMAND] [FLAGS]
```

--------------------------------

### Stream output with pager in Go

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Uses the system pager to display large datasets. Requires a label and a callback function that writes to the provided file pointer.

```go
func streamOutput(label string, generateOutput func(w *os.File) error) error
```

```go
err := streamOutput("Search Results", func(w *os.File) error {
    for i := 0; i < 10000; i++ {
        fmt.Fprintf(w, "Result %d\n", i)
    }
    return nil
})
```

--------------------------------

### Pass Files as Arguments

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Use the @ prefix to pass file contents as command arguments.

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

--------------------------------

### Execute search with pagination

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Perform a search query with a specified limit; results are automatically paginated via the system pager.

```bash
x-twitter-scraper x:tweets search --q "test" --limit 1000
# Output pages automatically via pager (PAGER environment variable)
```

--------------------------------

### Retrieve home timeline

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches the authenticated user's home timeline.

```bash
x-twitter-scraper x get-home-timeline [FLAGS]
```

--------------------------------

### Follow a user

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Follows a user using the authenticated account.

```bash
x-twitter-scraper x:users:follow create --account <ACCOUNT> --user-id <USER_ID> [FLAGS]
```

--------------------------------

### API Overview

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

General information regarding the Xquik REST API base URL, client SDK, and rate limiting policies.

```APIDOC
## API Overview

### Base URL
https://api.xquik.com (customizable with --base-url)

### API Client
github.com/Xquik-dev/x-twitter-scraper-go

### Response Format
JSON

### Rate Limiting
Per-user credit-based billing
```

--------------------------------

### Define OutputFormats constant

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Defines the slice of strings representing valid output formats for CLI flags.

```go
var OutputFormats = []string{"auto", "explore", "json", "jsonl", "pretty", "raw", "yaml"}
```

--------------------------------

### webhooks create

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Create a webhook for event delivery.

```APIDOC
## webhooks create

### Description
Create a webhook for event delivery.

### Usage
`x-twitter-scraper webhooks create --url <WEBHOOK_URL> --events <EVENT1>,<EVENT2>... [FLAGS]`

### Flags
- **--url** (string) - Required - Webhook URL for event delivery
- **--events** ([]string) - Required - Events to subscribe to (tweet_created, user_followed, etc.)
```

--------------------------------

### x:profiles

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands for retrieving and updating user profile information.

```APIDOC
## x:profiles retrieve
Get extended profile data.

### Flags
- **--username** (string) - Required

## x:profiles update
Update profile information.

### Flags
- **--account** (string) - Optional

## x:profiles retrieve-banner
Get profile banner image.

### Flags
- **--username** (string) - Optional

## x:profiles update-banner
Set profile banner.

### Flags
- **--account** (string) - Optional
- **--image** (string) - Optional

## x:profiles retrieve-avatar
Get profile avatar.

### Flags
- **--username** (string) - Optional

## x:profiles update-avatar
Set profile avatar.

### Flags
- **--account** (string) - Optional
- **--image** (string) - Optional
```

--------------------------------

### Map CLI Flag to Path Parameter

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that maps to a dynamic segment in the URL path.

```go
&requestflag.Flag[string]{
    Name:      "id",
    Required:  true,
    PathParam: "id",  // Maps to /tweets/{id}
}
```

```bash
x-twitter-scraper x:tweets retrieve --id 123
```

```http
GET /tweets/123 HTTP/1.1
```

--------------------------------

### x:users:follow

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands for managing user follow/unfollow operations.

```APIDOC
## x:users:follow create
Follow a user.

### Flags
- **--account** (string) - Optional
- **--user-id** (string) - Required

## x:users:follow delete
Unfollow a user.

### Flags
- **--account** (string) - Optional
- **--user-id** (string) - Required
```

--------------------------------

### Global Command Patterns for x-twitter-scraper-cli

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Common command-line patterns for formatting, transforming, and debugging scraper output.

```bash
# Display as YAML
x-twitter-scraper --format yaml x:tweets retrieve --id 123

# Interactive explore
x-twitter-scraper --format explore x:tweets retrieve --id 123

# Extract specific field
x-twitter-scraper --transform data.author.username x:tweets retrieve --id 123

# Debug HTTP calls
x-twitter-scraper --debug x:tweets search --q "test"

# Pipe to jq or other tools
x-twitter-scraper --format json x:tweets search --q "test" | jq '.data[].likes'

# Raw string output
x-twitter-scraper --format json --raw-output --transform data.author.username x:tweets retrieve --id 123
```

--------------------------------

### Retrieve multiple user profiles

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches multiple user profiles using a comma-separated list of usernames.

```bash
x-twitter-scraper x:users retrieve-batch --usernames <USER1>,<USER2>... [FLAGS]
```

--------------------------------

### x get-home-timeline

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Retrieve the home timeline for the authenticated user.

```APIDOC
## x get-home-timeline

### Description
Retrieve the home timeline for the authenticated user.

### Usage
`x-twitter-scraper x get-home-timeline [FLAGS]`

### Flags
- **--limit** (int64) - Optional - Maximum tweets to return
- **--cursor** (string) - Optional - Pagination cursor
```

--------------------------------

### Use Data URI for Files

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Specify file types using data URI schemes.

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

--------------------------------

### Handle Command Context

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Commands check the context for cancellation signals like SIGINT or SIGTERM before execution.

```go
func handleCommand(ctx context.Context, cmd *cli.Command) error {
    select {
    case <-ctx.Done():
        return ctx.Err()
    default:
        // Execute command
    }
}
```

--------------------------------

### Define Body Format and File Embed Constants

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Internal types and constants for defining content types and file embedding strategies.

```go
type BodyContentType int

const (
    EmptyBody BodyContentType = iota
    MultipartFormEncoded
    ApplicationJSON
    ApplicationOctetStream
)

type FileEmbedStyle int

const (
    EmbedText   FileEmbedStyle = iota  // Load files inline, base64-encode binary
    EmbedIOReader                      // Stream binary via io.Reader
)
```

--------------------------------

### Pipe JSON Data to CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Demonstrates piping JSON data into the CLI to populate unset flags.

```bash
cat data.json | x-twitter-scraper x:tweets create
```

--------------------------------

### Pass Files in JSON or YAML

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/README.md

Reference files within structured data formats.

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

--------------------------------

### Format Values for FlagSet

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/internal-modules.md

Prepares piped values for flag parsing by converting scalars to %v notation and serializing complex types to JSON.

```go
func formatForFlagSet(val any) (string, error)
```

--------------------------------

### Configure Base URL

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Override the default API base URL with a custom endpoint.

```bash
--base-url <URL>
```

```bash
x-twitter-scraper --base-url https://staging-api.xquik.com x:tweets search --q "test"
```

--------------------------------

### Define user authentication flags

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Configures header-based authentication flags that pull values from environment variables.

```go
&requestflag.Flag[string]{
    Name:       "api-key",
    HeaderPath: "X-API-Key",
    Sources:    cli.EnvVars("X_TWITTER_SCRAPER_API_KEY"),
},
&requestflag.Flag[string]{
    Name:       "bearer-token",
    HeaderPath: "Authorization",
    Sources:    cli.EnvVars("X_TWITTER_SCRAPER_BEARER_TOKEN"),
},
```

--------------------------------

### Map CLI Flag to Query Parameter

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that maps to a URL query parameter.

```go
&requestflag.Flag[string]{
    Name:      "q",
    Usage:     "Search query",
    QueryPath: "q",  // Maps to ?q=value
}
```

```bash
x-twitter-scraper x:tweets search --q "from:alice"
```

```http
GET /tweets/search?q=from%3Aalice HTTP/1.1
```

--------------------------------

### account set-x-username

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Sets the X username for the authenticated account.

```APIDOC
## x-twitter-scraper account set-x-username

### Description
Set the X username for the authenticated account.

### Usage
`x-twitter-scraper account set-x-username --username <USERNAME> [FLAGS]`

### Parameters
- **--username** (string) - Required - X account username to set
```

--------------------------------

### Retrieve user following

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches accounts that a specific user is following.

```bash
x-twitter-scraper x:users retrieve-following --username <USERNAME> [FLAGS]
```

--------------------------------

### Set Output Format

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Define the output format for success and error responses.

```bash
--format <FORMAT>
```

```bash
x-twitter-scraper --format json x:tweets retrieve --id 123
x-twitter-scraper --format yaml x:tweets retrieve --id 123
x-twitter-scraper --format explore x:tweets retrieve --id 123  # interactive mode
```

```bash
--format-error <FORMAT>
```

--------------------------------

### guessExtension

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Detects the file type from binary content and returns the appropriate file extension.

```APIDOC
## func guessExtension(data []byte) string

### Description
Detects file type from binary content and returns appropriate file extension.

### Parameters
- **data** ([]byte) - Required - Binary file content

### Returns
- File extension string (e.g., ".jpg", ".pdf", ".mp3")
- ".txt" for UTF-8 text content
- ".bin" for unknown binary formats
```

--------------------------------

### Enable Debug Logging

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Command to enable debug logging and pipe the output to a file for inspection.

```bash
x-twitter-scraper --debug x:tweets search --q "test" 2>&1 | tee debug.log
```

--------------------------------

### Retrieve a single user profile

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Fetches a user profile by username or ID.

```bash
x-twitter-scraper x:users retrieve --username <USERNAME> [FLAGS]
```

--------------------------------

### Documentation relationship map

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Visual representation of the project's documentation file structure and dependencies.

```text
README.md (this file)
├── entry-point.md              ← Execution flow, error handling
│   └── References: configuration.md, api-reference-cmdutil.md
├── api-reference-commands.md   ← All CLI commands
│   └── References: command-index.md, configuration.md
├── command-index.md            ← Detailed command reference
│   └── References: api-reference-commands.md
├── configuration.md            ← Env vars, flags, formats
│   └── References: api-reference-cmdutil.md
├── api-reference-cmdutil.md    ← Utility functions
│   └── References: internal-modules.md
├── api-reference-requestflag.md ← Flag → HTTP mapping
│   └── References: internal-modules.md
└── internal-modules.md         ← Internal utilities
    └── References: configuration.md
```

--------------------------------

### Map CLI Flag to Entire Request Body

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that represents the entire request body.

```go
&requestflag.Flag[map[string]any]{
    Name:     "body",
    BodyRoot: true,  // This flag IS the entire body
}
```

--------------------------------

### Configure Automatic File Embedding

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that automatically embeds files based on the provided path and content type.

```go
&requestflag.Flag[[]string]{
    Name:     "media",
    BodyPath: "media",
}
```

--------------------------------

### Environment Variables

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Configuration variables that can be set in the environment to override default CLI behavior.

```bash
X_TWITTER_SCRAPER_API_KEY        # API key (overridable with --api-key)
X_TWITTER_SCRAPER_BEARER_TOKEN   # Bearer token (overridable with --bearer-token)
X_TWITTER_SCRAPER_BASE_URL       # Custom API base URL
PAGER                            # Pager command for large output (default: less)
FORCE_COLOR                      # Force colors: 1=yes, 0=no
```

--------------------------------

### Retrieve User Profile and Network Data

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands to fetch user profiles, follower/following lists, and a user's tweet history.

```bash
# Get user profile
x-twitter-scraper x:users retrieve --username alice

# Get followers
x-twitter-scraper x:users retrieve-followers --username alice --limit 100

# Get following
x-twitter-scraper x:users retrieve-following --username alice

# Get user's tweets
x-twitter-scraper x:users retrieve-tweets --username alice --limit 50
```

--------------------------------

### Map CLI Flag to HTTP Header

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that maps to an HTTP request header.

```go
&requestflag.Flag[string]{
    Name:       "idempotency-key",
    HeaderPath: "Idempotency-Key",  // Maps to Idempotency-Key: value
}
```

```bash
x-twitter-scraper x:tweets create --idempotency-key "abc-123"
```

```http
POST /tweets HTTP/1.1
Idempotency-Key: abc-123
```

--------------------------------

### Like a tweet via CLI

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Performs a like action on a specified tweet using the provided account.

```bash
x-twitter-scraper x:tweets:like create --account <ACCOUNT> --tweet-id <TWEET_ID> [FLAGS]
```

--------------------------------

### Data extraction commands

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Commands for estimating costs, running extraction jobs, and exporting results.

```bash
x-twitter-scraper extractions estimate-cost --query <QUERY> [FLAGS]
```

```bash
x-twitter-scraper extractions run --query <QUERY> --format <FORMAT> [FLAGS]
```

```bash
x-twitter-scraper extractions export-results --id <EXTRACTION_ID> [FLAGS]
```

--------------------------------

### Command Handler Signature

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Standard function signature required for all command handlers in the CLI.

```go
func handleXTweetsCreate(ctx context.Context, cmd *cli.Command) error
```

--------------------------------

### Configure error output format

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Sets the format for error messages using the --format-error flag.

```bash
# Pretty-print errors as JSON
x-twitter-scraper --format-error json x:tweets search --q "test"

# Raw error output
x-twitter-scraper --format-error raw x:tweets search --q "test"
```

--------------------------------

### ShowJSONIterator usage

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Displays a stream of JSON objects with automatic pagination support for large datasets.

```go
type TweetResult struct {
    ID   string
    Text string
}

// Create an iterator over tweet search results
iter := searchTweets("from:elonmusk") // returns jsonview.Iterator[TweetResult]

// Display with automatic pagination, show up to 100 tweets
ShowJSONIterator(iter, 100, ShowJSONOpts{
    Format: "pretty",
    Title:  "Tweets",
    Stdout: os.Stdout,
})
```

--------------------------------

### Embed files in requests

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/README.md

Attach files to requests using the --media, --attachment, or --text flags with specific prefixes.

```bash
# Auto-detect file type
--media @photo.jpg

# Force text (UTF-8)
--media @file://message.txt

# Base64-encode binary
--attachment @data://binary.bin

# Read from stdin
--text @-
```

--------------------------------

### Check terminal color support

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Determines if colored output is appropriate by checking the FORCE_COLOR environment variable and terminal status.

```go
func shouldUseColors(w io.Writer) bool
```

```go
if shouldUseColors(os.Stdout) {
    output = pretty.Color(jsonBytes, pretty.TerminalStyle)
}
```

--------------------------------

### Define file upload flag

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Configures a flag to accept an array of file paths or URLs for body attachment.

```go
&requestflag.Flag[[]string]{
    Name:     "files",
    BodyPath: "attachments",  // Array of URLs or paths
},
```

--------------------------------

### Implement InRequest Interface

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

The InRequest interface exposes the HTTP mapping configuration for a flag.

```go
type InRequest interface {
    GetQueryPath() string       // Returns QueryPath
    GetHeaderPath() string      // Returns HeaderPath
    GetBodyPath() string        // Returns BodyPath
    GetPathParam() string       // Returns PathParam
    IsBodyRoot() bool           // Returns BodyRoot
    IsFileInput() bool          // Returns FileInput
    GetDataAliases() []string   // Returns DataAliases
}
```

--------------------------------

### Configure FilePathValue Type

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-requestflag.md

Defines a flag that treats the input value as a file path without requiring the @ prefix.

```go
&requestflag.Flag[FilePathValue]{
    Name:      "attachment",
    FileInput: true,  // Treat value as file path
    BodyPath:  "attachment",
}
```

--------------------------------

### Manage Tweet Creation and Interactions

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/command-index.md

Commands for creating, liking, and deleting tweets using account identifiers and idempotency keys.

```bash
# Create tweet
x-twitter-scraper x:tweets create \
  --account myaccount \
  --text "Hello world" \
  --idempotency-key "abc-123"

# Like tweet
x-twitter-scraper x:tweets:like create \
  --account myaccount \
  --tweet-id 12345

# Delete tweet
x-twitter-scraper x:tweets delete \
  --id 12345 \
  --account myaccount \
  --idempotency-key "del-abc-123"
```

--------------------------------

### extractions run

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Run a data extraction job.

```APIDOC
## extractions run

### Description
Run a data extraction job.

### Usage
`x-twitter-scraper extractions run --query <QUERY> --format <FORMAT> [FLAGS]`

### Flags
- **--query** (string) - Required - Search query
- **--format** (string) - Optional - Output format (json, csv)
```

--------------------------------

### Set Authentication Flags

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/configuration.md

Flags for providing API keys or bearer tokens, which take precedence over environment variables.

```bash
--api-key <API_KEY>
```

```bash
--bearer-token <BEARER_TOKEN>
```

--------------------------------

### Create Tweet

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Creates a new tweet, supporting optional media and reply functionality.

```bash
x-twitter-scraper x:tweets create --account <ACCOUNT> --idempotency-key <KEY> [FLAGS]
```

--------------------------------

### shouldUseColors

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-cmdutil.md

Determines whether to use colored output based on terminal detection and environment variables.

```APIDOC
## func shouldUseColors(w io.Writer) bool

### Description
Determines whether to use colored output based on terminal detection and environment. Checks FORCE_COLOR environment variable first, then falls back to terminal detection.

### Parameters
- **w** (io.Writer) - Required - The output writer to test

### Returns
- **bool** - true if colors should be used, false if output should be plain
```

--------------------------------

### Search for users

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Searches for users based on a query string matching username or bio.

```bash
x-twitter-scraper x:users retrieve-search --q <QUERY> [FLAGS]
```

--------------------------------

### Define newCommand Function Signature

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Signature for the function responsible for creating and configuring the root CLI command.

```go
func newCommand() *cli.Command
```

--------------------------------

### Handle CLI Command Errors

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/entry-point.md

Logic for determining exit codes, processing API-specific errors, and formatting output for non-API errors.

```go
exitCode := 1
if exitErr, ok := err.(cli.ExitCoder); ok {
    exitCode = exitErr.ExitCode()
}
```

```go
var apierr *xtwitterscraper.Error
if errors.As(err, &apierr) {
    // Print: METHOD "URL": STATUS_CODE STATUS_TEXT
    fmt.Fprintf(stderr, "%s %q: %d %s\n", 
        apierr.Request.Method, 
        apierr.Request.URL, 
        apierr.Response.StatusCode, 
        http.StatusText(apierr.Response.StatusCode))
    
    // Format error response JSON
    json := gjson.Parse(apierr.RawJSON())
    showErr := cmd.ShowJSON(json, cmd.ShowJSONOpts{
        ExplicitFormat: app.IsSet("format-error"),
        Format:         app.String("format-error"),
        Title:          "Error",
        Transform:      app.String("transform-error"),
    })
    if showErr != nil {
        fmt.Fprintf(stderr, "%s\n", err.Error())
    }
}
```

```go
} else {
    if cmd.CommandErrorBuffer.Len() > 0 {
        _, _ = stderr.Write(cmd.CommandErrorBuffer.Bytes())
    } else {
        fmt.Fprintf(stderr, "%s\n", err.Error())
    }
}
```

```go
return exitCode
```

--------------------------------

### Explore JSON Data

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/internal-modules.md

Functions for interactive and static JSON visualization in the terminal.

```go
func ExploreJSON(title string, res gjson.Result) error
```

```go
func ExploreJSONStream(title string, iter Iterator[T]) error
```

```go
func RenderJSON(title string, res gjson.Result) string
```

--------------------------------

### x:tweets:like create

Source: https://github.com/xquik-dev/x-twitter-scraper-cli/blob/main/_autodocs/api-reference-commands.md

Likes a specified tweet using the provided account.

```APIDOC
## x:tweets:like create

### Description
Like a tweet.

### Command
`x-twitter-scraper x:tweets:like create --account <ACCOUNT> --tweet-id <TWEET_ID>`

### Parameters
- **--account** (string) - Required - X account (@username or account ID)
- **--tweet-id** (string) - Required - Tweet ID to like
```
Tokens:
Raw