twitter-snap

Create beautiful Tweet images fast. Fast, good design, Browser is not a dependency.

npx twitter-snap@latest https://x.com/SpaceX/status/1786759044948189202

# Interactive mode
npx twitter-snap@latest -i

# Login with cookies
npx twitter-snap@latest https://twitter.com/elonmusk/status/1349129669258448897 --session-type file --cookies-file cookies.json
# Login with puppeteer
npx twitter-snap@latest https://twitter.com/elonmusk/status/1349129669258448897 --session-type browser

# Output the API response directly to a file in raw JSON format.
npx twitter-snap@latest --theme Json https://x.com/elonmusk/status/1349129669258448897 -o output/data.json
# Download the media file and save it directly to a file in its raw format.
npx twitter-snap@latest --theme Media https://x.com/elonmusk/status/1349129669258448897 -o output/{count}
# Output as WebP (animated when the post has a video).
npx twitter-snap@latest https://x.com/SpaceX/status/1786759044948189202 -o output/{id}.webp
# Output one frame as WebP.
npx twitter-snap@latest https://x.com/SpaceX/status/1786759044948189202 -o output/{id}.webp --ffmpeg-additonal-option "-frames:v 1 -lossless 1"
# Use chatgpt to summarize the data in this tweet.
npx twitter-snap@latest --theme LiteJson -o {stdout} https://x.com/elonmusk | chatgpt -p 'Summarize the data in this tweet.'

# Look like the post page of x.com.
npx twitter-snap@latest --theme RenderXReference https://x.com/elonmusk/status/1604617643973124097
# Include the author's thread.
npx twitter-snap@latest --thread https://x.com/SpaceX/status/1786759044948189202
# Translate the post.
npx twitter-snap@latest --translate en https://x.com/teslajapan/status/2113567187046993971 --session-type file

Install

npm -g i twitter-snap@latest

Docker

docker run -it --rm -v $(pwd)/output:/app/output ghcr.io/fa0311/twitter-snap/twitter-snap-docker:latest https://x.com/elonmusk/status/1349129669258448897

docker run -it --rm -v $(pwd)/output:/app/output -v $(pwd)/cookies.json:/app/cookies.json ghcr.io/fa0311/twitter-snap/twitter-snap-docker:latest https://x.com/elonmusk/status/1349129669258448897 --session-type file

--session-type=browser is not supported.

GPU is not supported.

Use as a package

npm i twitter-snap

import {getSnapAppRender} from 'twitter-snap'

const snap = getSnapAppRender({url: 'https://x.com/elonmusk/status/1349129669258448897'})
const font = await snap.getFont()
const session = await snap.login({sessionType: 'guest'})
const render = await snap.getRender({limit: 1, session})

await snap.run(render, async (run) => {
  const res = await run({
    width: 650,
    theme: 'RenderOceanBlueColor',
    font,
    output: 'temp/{id}-{count}.{if-type:png:mp4:json:}',
  })
  await res.file.tempCleanup()
})

import {getSnapAppRenderWithCache} from 'twitter-snap'

const snap = getSnapAppRenderWithCache({})
const res = await snap({
  url: 'https://x.com/elonmusk/status/1349129669258448897',
  callback: async (run) => {
    const res = await run({
      width: 1440,
      scale: 2,
      theme: 'RenderOceanBlueColor',
      output: 'temp/{id}-{count}.{if-type:png:mp4:json:}',
    })
    await res.file.tempCleanup()
  },
})

Usage

$ node bin/run.js --help
Create beautiful Tweet images fast

USAGE
  $ twitter-snap  URL [--browserHeadless] [--browserProfile
    <value>] [--cookiesFile <value>] [--debug] [--interactive]
    [--ffmpegAdditonalOption <value>] [--ffmpegTimeout <value>] [--ffmpegPath
    <value>] [--ffprobePath <value>] [--fontPath <value>] [--limit <value>]
    [--noCleanup] [--outputPrefix <value>] [-o <value>] [--sessionType
    browser|file|guest] [--simpleLog] [--sleep <value>] [--translate <value>]
    [--theme
    RenderOceanBlueColor|RenderOceanBlueDarkColor|RenderSunsetGardenColor|Render
    SunsetGardenDarkColor|RenderDawnBlossomColor|RenderDawnBlossomDarkColor|Rend
    erFierySunsetColor|RenderFierySunsetDarkColor|RenderTwilightSkyColor|RenderT
    wilightSkyDarkColor|RenderPlainColor|RenderPlainDarkColor|RenderTransparent|
    RenderTransparentDark|RenderTransparentShadow|RenderTransparentShadowDark|Re
    nderXReference|RenderXReferenceDark|Json|LiteJson|Media|RenderMakeItAQuote]
    [--thread] [--width <value>] [--scale <value>]

ARGUMENTS
  URL  Twitter url

FLAGS
  -o, --output=<value>
      [default: {id}-{count}.{if-type:png:mp4:json:}] Output file name

  --browserHeadless
      Browser headless

  --browserProfile=<value>
      [default: ~/.cache/twitter-snap/profiles] Browser profile

  --cookiesFile=<value>
      [default: cookies.json] Cookies file

  --debug
      Debug

  --ffmpegAdditonalOption=<value>
      FFmpeg additonal option

  --ffmpegPath=<value>
      [default: ffmpeg] FFmpeg path

  --ffmpegTimeout=<value>
      [default: -1] FFmpeg timeout

  --ffprobePath=<value>
      [default: ffprobe] FFprobe path

  --fontPath=<value>
      [default: ~/.cache/twitter-snap/fonts] Font path

  --interactive
      Enable interactive mode

  --limit=<value>
      [default: 20] Limit count

  --noCleanup
      Cleanup

  --outputPrefix=<value>
      Output file name prefix

  --scale=<value>
      [default: 1] Scale

  --sessionType=<option>
      [default: guest] Session type
      <options: browser|file|guest>

  --simpleLog
      Simple log

  --sleep=<value>
      Sleep (ms)

  --theme=<option>
      [default: RenderOceanBlueColor] Theme type
      <options:
      RenderOceanBlueColor|RenderOceanBlueDarkColor|RenderSunsetGardenColor|Render
      SunsetGardenDarkColor|RenderDawnBlossomColor|RenderDawnBlossomDarkColor|Rend
      erFierySunsetColor|RenderFierySunsetDarkColor|RenderTwilightSkyColor|RenderT
      wilightSkyDarkColor|RenderPlainColor|RenderPlainDarkColor|RenderTransparent|
      RenderTransparentDark|RenderTransparentShadow|RenderTransparentShadowDark|Re
      nderXReference|RenderXReferenceDark|Json|LiteJson|Media|RenderMakeItAQuote>

  --thread
      The author's thread (their chain of self-replies) around the tweet, in one
      image

  --translate=<value>
      Show the post translated into this language, as x.com does (x.com language
      code: en, ja, ...)

  --width=<value>
      Width (650 unless set, 600 for RenderXReference)

DESCRIPTION
  Create beautiful Tweet images fast
  https://github.com/fa0311/twitter-snap

EXAMPLES
  Create a snap from tweet id with minimal commands.

    $ twitter-snap https://twitter.com/elonmusk/status/1349129669258448897

  Enable interactive mode.

    $ twitter-snap --interactive

Features

• https?://(www.)?(mobile.)?(x|twitter).com

  • /:user/status/:id
  • /search?:params
  • /home
  • /i/lists/:id
  • /:user/with_replies
  • /:user/media
  • /:user/likes
  • /:user
  • /i/bookmarks

• https?://(www.)?pixiv.net

  • /artworks/:id

Dependence

• ffmpeg (for video)