daylin/yartsu
1
0
Fork 0
mirror of https://github.com/daylinmorgan/yartsu.git synced 2024-12-22 12:30:43 -06:00
Code Issues Projects Releases Packages Wiki Activity
yartsu/index.html

632 lines
23 KiB
HTML
Raw Normal View History

deploy: a14608d21c0ac29e3d51358daa83eba8fd8e65c0
2023-05-14 15:20:58 -05:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://gh.dayl.in/yartsu/">
<link rel="next" href="rich-diff/">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<title>Yartsu</title>
<link rel="stylesheet" href="assets/stylesheets/main.85bb2934.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.a6bdf11c.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="indigo">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#yartsu" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="Yartsu" class="md-header__button md-logo" aria-label="Yartsu" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Yartsu
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Yartsu
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
</form>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/daylinmorgan/yartsu" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
daylinmorgan/yartsu
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="Yartsu" class="md-nav__button md-logo" aria-label="Yartsu" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Yartsu
</label>
<div class="md-nav__source">
<a href="https://github.com/daylinmorgan/yartsu" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
daylinmorgan/yartsu
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Yartsu
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
Yartsu
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#install" class="md-nav__link">
Install
</a>
<nav class="md-nav" aria-label="Install">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#releases" class="md-nav__link">
Releases
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>
<nav class="md-nav" aria-label="Usage">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-pipes" class="md-nav__link">
Option 1: Pipes
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-subprocesspty" class="md-nav__link">
Option 2: Subprocess/Pty
</a>
</li>
<li class="md-nav__item">
<a href="#option-3-text-file" class="md-nav__link">
Option 3: Text File
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#themes" class="md-nav__link">
Themes
</a>
</li>
<li class="md-nav__item">
<a href="#differences-from-rich" class="md-nav__link">
Differences from Rich
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="rich-diff/" class="md-nav__link">
Deviation From Rich
</a>
</li>
<li class="md-nav__item">
<a href="themes/" class="md-nav__link">
Themes
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#install" class="md-nav__link">
Install
</a>
<nav class="md-nav" aria-label="Install">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#releases" class="md-nav__link">
Releases
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>
<nav class="md-nav" aria-label="Usage">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-pipes" class="md-nav__link">
Option 1: Pipes
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-subprocesspty" class="md-nav__link">
Option 2: Subprocess/Pty
</a>
</li>
<li class="md-nav__item">
<a href="#option-3-text-file" class="md-nav__link">
Option 3: Text File
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#themes" class="md-nav__link">
Themes
</a>
</li>
<li class="md-nav__item">
<a href="#differences-from-rich" class="md-nav__link">
Differences from Rich
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="yartsu">Yartsu</h1>
<div id="top"></div>
<!-- PROJECT LOGO -->
<div align="center">
<a href="https://github.com/daylinmorgan/yartsu">
<img src="https://raw.githubusercontent.com/daylinmorgan/yartsu/main/assets/logo.svg" alt="Logo" width=600 >
</a>
<p align="center">
yartsu, another rich terminal screenshot utility
</p>
<p align="center">
<a href="https://gh.dayl.in/yartsu">
Documentation
</a>
</p>
</div>
<p><br /></p>
<!-- PROJECT SHIELDS -->
<p><a href="https://github.com/daylinmorgan/yartsu/stargazers"><img alt="Stargazers" src="https://img.shields.io/github/stars/daylinmorgan/yartsu.svg?style=flat" /></a>
<a href="https://github.com/daylinmorgan/yartsu/issues"><img alt="Issues" src="https://img.shields.io/github/issues/daylinmorgan/yartsu.svg?style=flat" /></a>
<a href="https://github.com/daylinmorgan/yartsu/blob/main/LICENSE.txt"><img alt="MIT License" src="https://img.shields.io/github/license/daylinmorgan/yartsu.svg?style=flat" /></a></p>
<p><strong>NOTE</strong>: this is a currently in a beta release and the API is subject to change (feedback welcome)</p>
<p>Inspired by recent commits in the wonderful library <a href="https://github.com/Textualize/rich"><code>rich</code></a> I decided to write <code>yartsu</code>.</p>
<p>I needed to programmatically generate screenshots for documentation purposes. The new <code>export_svg</code> methods in <code>rich</code> were a godsend.
So I wanted to try to make this feature a little more generalizable to program output outside of <code>rich</code>/<code>python</code>.
Hopefully, you find it useful.</p>
<p>If you come across anything unexpected please submit an issue.</p>
<h2 id="install">Install</h2>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pipx<span class="w"> </span>install<span class="w"> </span>yartsu
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="c1"># OR</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>pip<span class="w"> </span>install<span class="w"> </span>yartsu
</code></pre></div>
<h3 id="releases">Releases</h3>
<p>There is a standalone binary available for linux in the <a href="https://github.com/daylinmorgan/yartsu/releases">releases</a>
(Support for additional platforms is <a href="https://github.com/daylinmorgan/yartsu/issues/3">planned</a>).</p>
<p>Optionally install with <a href="https://github.com/zyedidia/eget"><code>eget</code></a>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>eget<span class="w"> </span>daylinmorgan/yartsu
</code></pre></div>
<p>Otherwise you can download an extract manually to somewhere on your path.</p>
<h2 id="usage">Usage</h2>
<div align="center"><img src="https://raw.githubusercontent.com/daylinmorgan/yartsu/main/assets/help.svg" alt="Logo" width=600 ></div>
<p>Getting a properly formatted output from a terminal screenshot is challenging.</p>
<p>There are three options for generating a screenshot.</p>
<p>If one of the below option causes you any headaches consider first trying a different option.</p>
<h3 id="option-1-pipes">Option 1: Pipes</h3>
<p>Many tools that color output (i.e. <code>grep</code> or <code>ls</code>) additionally allow
you to force ANSI color codes to be included even when piping output.</p>
<p>In these cases you can simply pipe the output directly into <code>yartsu</code></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>ls<span class="w"> </span>--color<span class="o">=</span>always<span class="w"> </span><span class="p">|</span><span class="w"> </span>yartsu<span class="w"> </span>-w<span class="w"> </span><span class="m">50</span><span class="w"> </span>-o<span class="w"> </span>assets/ls_color.svg
</code></pre></div>
<h3 id="option-2-subprocesspty">Option 2: Subprocess/Pty</h3>
<p>With this option <code>yartsu</code> will deploy a <code>subprocess</code> and <code>pty</code>
to run your command for you in an attempt to preserve ANSI.</p>
<p>Note with this option you need to separate
the command you want to run with <code>yartsu</code> args using <code>--</code>.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>yartsu<span class="w"> </span>-w<span class="w"> </span><span class="m">50</span><span class="w"> </span>-o<span class="w"> </span>assets/ls_color.svg<span class="w"> </span>--<span class="w"> </span>ls<span class="w"> </span>--color<span class="w"> </span>/
</code></pre></div>
<h3 id="option-3-text-file">Option 3: Text File</h3>
<p>Finally, if you neither of the above options work and you can
manage to preserve the codes in a plain text file you can pass this as input to <code>yartsu</code>.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>ls<span class="w"> </span>--color<span class="w"> </span>&gt;<span class="w"> </span>ls.txt
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>yartsu<span class="w"> </span>-w<span class="w"> </span><span class="m">50</span><span class="w"> </span>-i<span class="w"> </span>ls.txt<span class="w"> </span>-o<span class="w"> </span>assets/ls_color.svg
</code></pre></div>
<p>By default svgs will be saved at <code>./capture.svg</code>.</p>
<p>Additionally, for options 1 and 3 you may want to define your own title with <code>-t/--title</code>.
For option 2 the title will by default be the cmd ran by <code>yartsu</code>.</p>
<h2 id="themes">Themes</h2>
<p>There are a number of themes you can use to style output.
Use <code>yartsu --list-themes</code> to see the available options.
Then you can specify the theme you want with <code>--theme</code>, i.e. <code>yartsu --theme rich_default</code>.
You may also use the environment variable <code>YARTSU_THEME</code>.</p>
<p>See <a href="https://gh.dayl.in/yartsu/themes">here</a> a preview of the available themes</p>
<h2 id="differences-from-rich">Differences from <a href="https://github.com/Textualize/rich"><code>Rich</code></a></h2>
<p>For both practical and stylistic reasons the underlying code used to generate the SVG is slightly different than <code>rich</code>'s default <code>save_svg</code> method. See <a href="https://gh.dayl.in/rich-diff">here</a> for the current deviation between the latest releases of each respective release.</p>
<!-- MARKDOWN LINKS & IMAGES -->
<hr>
<div class="md-source-file">
<small>
Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 14, 2023</span>
<br>
Created:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 14, 2022</span>
</small>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.indexes"], "search": "assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="assets/javascripts/bundle.fac441b0.min.js"></script>
</body>
</html>
Reference in a new issue Copy permalink