twt/docs/index.html

510 lines
24 KiB
HTML

<!DOCTYPE html>
<html lang="en" id="oranda" class="dark">
<head>
<title>twt</title>
<meta property="og:url" content="https://github.com/msfjarvis/twt" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Tools for extracting metadata from tweets" />
<meta property="og:description" content="Tools for extracting metadata from tweets" />
<meta property="og:type" content="website" />
<meta property="og:title" content="twt" />
<meta http-equiv="Permissions-Policy" content="interest-cohort=()" />
<link rel="stylesheet" href="/twt/oranda-v0.3.0-prerelease.4.css" />
</head>
<body>
<div class="container">
<div class="page-body">
<div class="repo_banner">
<a href="https://github.com/msfjarvis/twt">
<div class="github-icon" aria-hidden="true"></div>
Check out our GitHub!
</a>
</div>
<main>
<header>
<h1 class="title">twt</h1>
<nav class="nav">
<ul>
<li><a href="/twt/">Home</a></li>
<li><a href="/twt/artifacts/">Install</a></li>
</ul>
</nav>
</header>
<div class="artifacts" data-tag="v1.2.4">
<div class="artifact-header target">
<h4>Install v1.2.4</h4>
<div><small class="published-date">Published on Aug 16 2023 at 09:55 UTC</small></div>
<ul class="arches">
<li class="arch hidden" data-arch="x86_64-unknown-linux-gnu">
<ul class="tabs">
<li class="install-tab" data-id="2" data-triple="x86_64-unknown-linux-gnu">
shell
</li>
<li class="install-tab" data-id="0" data-triple="x86_64-unknown-linux-gnu">
nix flakes
</li>
<li class="install-tab" data-id="5" data-triple="x86_64-unknown-linux-gnu">
tarball
</li>
</ul>
<ul class="contents">
<li data-id="2" data-triple="x86_64-unknown-linux-gnu" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/twt/installer.sh.txt">Source</a>
</div>
</li>
<li data-id="0" data-triple="x86_64-unknown-linux-gnu" class="install-content hidden">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">nix profile install github:msfjarvis/twt</span></pre>
<button class="button copy-clipboard-button primary" data-copy="nix profile install github:msfjarvis/twt">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
</div>
</li>
<li data-id="5" data-triple="x86_64-unknown-linux-gnu" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/twt/releases/download/v1.2.4/twt-v1.2.4-x86_64-unknown-linux-gnu.tar.xz">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">twt-v1.2.4-x86_64-unknown-linux-gnu.tar.xz</span>
</button>
</a>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="x86_64-apple-darwin">
<ul class="tabs">
<li class="install-tab" data-id="2" data-triple="x86_64-apple-darwin">
shell
</li>
<li class="install-tab" data-id="0" data-triple="x86_64-apple-darwin">
nix flakes
</li>
<li class="install-tab" data-id="3" data-triple="x86_64-apple-darwin">
tarball
</li>
</ul>
<ul class="contents">
<li data-id="2" data-triple="x86_64-apple-darwin" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/twt/installer.sh.txt">Source</a>
</div>
</li>
<li data-id="0" data-triple="x86_64-apple-darwin" class="install-content hidden">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">nix profile install github:msfjarvis/twt</span></pre>
<button class="button copy-clipboard-button primary" data-copy="nix profile install github:msfjarvis/twt">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
</div>
</li>
<li data-id="3" data-triple="x86_64-apple-darwin" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/twt/releases/download/v1.2.4/twt-v1.2.4-x86_64-apple-darwin.tar.xz">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">twt-v1.2.4-x86_64-apple-darwin.tar.xz</span>
</button>
</a>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="aarch64-apple-darwin">
<ul class="tabs">
<li class="install-tab" data-id="2" data-triple="aarch64-apple-darwin">
shell
</li>
<li class="install-tab" data-id="0" data-triple="aarch64-apple-darwin">
nix flakes
</li>
</ul>
<ul class="contents">
<li data-id="2" data-triple="aarch64-apple-darwin" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/twt/installer.sh.txt">Source</a>
</div>
</li>
<li data-id="0" data-triple="aarch64-apple-darwin" class="install-content hidden">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">nix profile install github:msfjarvis/twt</span></pre>
<button class="button copy-clipboard-button primary" data-copy="nix profile install github:msfjarvis/twt">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="x86_64-pc-windows-msvc">
<ul class="tabs">
<li class="install-tab" data-id="1" data-triple="x86_64-pc-windows-msvc">
powershell
</li>
<li class="install-tab" data-id="0" data-triple="x86_64-pc-windows-msvc">
nix flakes
</li>
<li class="install-tab" data-id="4" data-triple="x86_64-pc-windows-msvc">
zip
</li>
</ul>
<ul class="contents">
<li data-id="1" data-triple="x86_64-pc-windows-msvc" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">irm https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.ps1 </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">iex</span></pre>
<button class="button copy-clipboard-button primary" data-copy="irm https://github.com/msfjarvis/twt/releases/download/v1.2.4/installer.ps1 | iex">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/twt/installer.ps1.txt">Source</a>
</div>
</li>
<li data-id="0" data-triple="x86_64-pc-windows-msvc" class="install-content hidden">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">nix profile install github:msfjarvis/twt</span></pre>
<button class="button copy-clipboard-button primary" data-copy="nix profile install github:msfjarvis/twt">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
</div>
</li>
<li data-id="4" data-triple="x86_64-pc-windows-msvc" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/twt/releases/download/v1.2.4/twt-v1.2.4-x86_64-pc-windows-msvc.zip">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">twt-v1.2.4-x86_64-pc-windows-msvc.zip</span>
</button>
</a>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="no-autodetect hidden">
<span class="no-autodetect-details">We weren't able to detect your OS.</span>
</div>
<noscript>
<a href="/twt/artifacts/">View all installation options</a>
</noscript>
<div class="mac-switch hidden">This project doesn't offer Apple Silicon downloads, but you can run Intel macOS binaries via Rosetta 2.</div>
<div class="bottom-options ">
<a href="/twt/artifacts/" class="backup-download primary">View all installation options</a>
<div class="arch-select hidden">
<select id="install-arch-select">
<option disabled="true" selected="true" value=""></option>
<option value="x86_64-unknown-linux-gnu">Linux x64</option>
<option value="aarch64-apple-darwin">macOS Apple Silicon</option>
<option value="x86_64-apple-darwin">macOS Intel</option>
<option value="x86_64-pc-windows-msvc">Windows x64</option>
</select>
</div>
</div>
</div>
<a href="/twt/artifacts/" class="button mobile-download primary">View all installation options</a>
<h1>twt <a href="http://unmaintained.tech/" rel="noopener noreferrer"><img src="http://unmaintained.tech/badge.svg" alt="No Maintenance Intended"></a> <a href="https://garnix.io" rel="noopener noreferrer"><img src="https://img.shields.io/static/v1?label=Built%20with&amp;message=Garnix&amp;color=blue&amp;style=flat&amp;logo=nixos&amp;link=https://garnix.io&amp;labelColor=111212" alt="Built with Garnix"></a></h1>
<p>CLI tool to extract metadata from tweets</p>
<h2>Install</h2>
<p>Check out the <a href="https://msfjarvis.github.io/twt/" rel="noopener noreferrer">website</a></p>
<h2>Setup</h2>
<p>This tool requires Twitter consumer keys to function. Twitter is moving to <a href="https://fxtwitter.com/twitterdev/status/1621026986784337922" rel="noopener noreferrer">disallow free usage of the API</a>, so you will have to steal their own keys to work around this.</p>
<p><code>twt</code> picks up keys from <code>$CONFIG_DIR/twt/config.toml</code> (see <a href="https://docs.rs/dirs/latest/dirs/fn.config_dir.html" rel="noopener noreferrer">here</a> for your platform's interpretation of <code>$CONFIG_DIR</code>)</p>
<pre style="background-color:#263238;"><span style="font-style:italic;color:#546e7a;"># config.toml
</span><span style="color:#f07178;">consumer_key </span><span style="color:#89ddff;">= "</span><span style="color:#c3e88d;">totally_real_key</span><span style="color:#89ddff;">"
</span><span style="color:#f07178;">consumer_key_secret </span><span style="color:#89ddff;">= "</span><span style="color:#c3e88d;">h4xx0r</span><span style="color:#89ddff;">"
</span></pre>
<h2>Usage</h2>
<h3>Get image links</h3>
<pre style="background-color:#263238;"><span style="color:#eeffff;">twt images --username archillect
</span></pre>
<h3>Get video links</h3>
<pre style="background-color:#263238;"><span style="color:#eeffff;">twt videos --username imgur
</span></pre>
<h3>Set the maximum tweets to check</h3>
<pre style="background-color:#263238;"><span style="color:#eeffff;">twt images --username archillect --max-amount 512
</span></pre>
<h3>Get all links</h3>
<pre style="background-color:#263238;"><span style="color:#eeffff;">twt links --username AITA_online --host bit.ly
</span></pre>
<p>For more help run: <code>twt -h</code>.</p>
</main>
</div>
<footer>
<a href="https://github.com/msfjarvis/twt"><div class="github-icon" aria-hidden="true"></div></a>
<span>
twt, MIT/Apache-2.0
</span>
</footer>
</div>
<script src="/twt/artifacts.js"></script>
</body>
</html>