From b2629a6253fd2ceec916b3e980285e79b067fbfb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 3 Oct 2022 18:30:25 +0000 Subject: [PATCH] Generate new screengrabs with rich-codex --- docs/img/before_after_command.svg | 18 +- docs/img/cat.svg | 176 ++++----- docs/img/example-json-snippet.svg | 104 ++--- docs/img/example-python-snippet.svg | 76 ++-- docs/img/fake_command.svg | 22 +- docs/img/git-pull-rebase.svg | 58 +-- docs/img/git-push-error.svg | 58 +-- docs/img/git-push-success.svg | 58 +-- docs/img/head-tail.svg | 94 ++--- docs/img/hide-command-default.svg | 18 +- docs/img/hide-command.svg | 14 +- docs/img/rich-codex-cli-envs.svg | 224 +++++------ docs/img/rich-codex-cli-help.svg | 224 +++++------ docs/img/rich-codex-help-min-pct.svg | 440 +++++++++++----------- docs/img/rich-codex-help.svg | 224 +++++------ docs/img/rich-codex-snippet-title.svg | 118 +++--- docs/img/rich-codex-snippet.svg | 100 ++--- docs/img/snippet-syntax.svg | 48 +-- docs/img/snippet-theme-fruity.svg | 82 ++-- docs/img/snippet-theme-monokai.svg | 84 ++--- docs/img/snippet-theme-sas.svg | 80 ++-- docs/img/taste-the-rainbow.svg | 82 ++-- docs/img/theme-default_terminal_theme.svg | 44 +-- docs/img/theme-dimmed_monokai.svg | 44 +-- docs/img/theme-monokai.svg | 44 +-- docs/img/theme-night_owlish.svg | 44 +-- docs/img/theme-svg_export_theme.svg | 44 +-- docs/img/title-command-default.svg | 18 +- docs/img/title-command.svg | 20 +- docs/img/trim-after_truncated-text.svg | 88 ++--- 30 files changed, 1374 insertions(+), 1374 deletions(-) diff --git a/docs/img/before_after_command.svg b/docs/img/before_after_command.svg index ca1d21c..0fa020d 100644 --- a/docs/img/before_after_command.svg +++ b/docs/img/before_after_command.svg @@ -19,27 +19,27 @@ font-weight: 700; } - .terminal-2053708125-matrix { + .terminal-1584539813-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2053708125-title { + .terminal-1584539813-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2053708125-r1 { fill: #c5c8c6 } + .terminal-1584539813-r1 { fill: #c5c8c6 } - + - + @@ -51,11 +51,11 @@ - + - - $ cat before_after_command_example.txt -This is a very simple example + + $ cat before_after_command_example.txt +This is a very simple example diff --git a/docs/img/cat.svg b/docs/img/cat.svg index 02417cd..4d41560 100644 --- a/docs/img/cat.svg +++ b/docs/img/cat.svg @@ -19,133 +19,133 @@ font-weight: 700; } - .terminal-175817084-matrix { + .terminal-2338810363-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-175817084-title { + .terminal-2338810363-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-175817084-r1 { fill: #c5c8c6 } -.terminal-175817084-r2 { fill: #afff00 } -.terminal-175817084-r3 { fill: #afd700 } -.terminal-175817084-r4 { fill: #d7d700 } -.terminal-175817084-r5 { fill: #d7af00 } -.terminal-175817084-r6 { fill: #ffaf00 } -.terminal-175817084-r7 { fill: #ff8700 } -.terminal-175817084-r8 { fill: #ff875f } -.terminal-175817084-r9 { fill: #ff5f5f } -.terminal-175817084-r10 { fill: #ff5f87 } -.terminal-175817084-r11 { fill: #ff0087 } -.terminal-175817084-r12 { fill: #ff00af } -.terminal-175817084-r13 { fill: #d700af } -.terminal-175817084-r14 { fill: #d700d7 } -.terminal-175817084-r15 { fill: #af00d7 } -.terminal-175817084-r16 { fill: #af00ff } -.terminal-175817084-r17 { fill: #8700ff } -.terminal-175817084-r18 { fill: #875fff } -.terminal-175817084-r19 { fill: #5f5fff } -.terminal-175817084-r20 { fill: #5f87ff } -.terminal-175817084-r21 { fill: #0087ff } -.terminal-175817084-r22 { fill: #00afff } -.terminal-175817084-r23 { fill: #00afd7 } -.terminal-175817084-r24 { fill: #00d7d7 } -.terminal-175817084-r25 { fill: #00d7af } -.terminal-175817084-r26 { fill: #00ffaf } + .terminal-2338810363-r1 { fill: #c5c8c6 } +.terminal-2338810363-r2 { fill: #afff00 } +.terminal-2338810363-r3 { fill: #afd700 } +.terminal-2338810363-r4 { fill: #d7d700 } +.terminal-2338810363-r5 { fill: #d7af00 } +.terminal-2338810363-r6 { fill: #ffaf00 } +.terminal-2338810363-r7 { fill: #ff8700 } +.terminal-2338810363-r8 { fill: #ff875f } +.terminal-2338810363-r9 { fill: #ff5f5f } +.terminal-2338810363-r10 { fill: #ff5f87 } +.terminal-2338810363-r11 { fill: #ff0087 } +.terminal-2338810363-r12 { fill: #ff00af } +.terminal-2338810363-r13 { fill: #d700af } +.terminal-2338810363-r14 { fill: #d700d7 } +.terminal-2338810363-r15 { fill: #af00d7 } +.terminal-2338810363-r16 { fill: #af00ff } +.terminal-2338810363-r17 { fill: #8700ff } +.terminal-2338810363-r18 { fill: #875fff } +.terminal-2338810363-r19 { fill: #5f5fff } +.terminal-2338810363-r20 { fill: #5f87ff } +.terminal-2338810363-r21 { fill: #0087ff } +.terminal-2338810363-r22 { fill: #00afff } +.terminal-2338810363-r23 { fill: #00afd7 } +.terminal-2338810363-r24 { fill: #00d7d7 } +.terminal-2338810363-r25 { fill: #00d7af } +.terminal-2338810363-r26 { fill: #00ffaf } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -157,38 +157,38 @@ - + - - $ cat cat.txt | lolcat -S 1 -WNNNWWWWNXXXNW -NK0000KXWWNK000000N -WKO0000000XNWWXK00000000KW -N0O0KXXK0000XNWWX0000KKXXK00KN -WX000XXXXXK0000XWWWWWWWWWWWWWWWNK000KKXXXXXK00N -WX000XXXXXXK0000KXK000OO0000OO000KK0000KXXXXXXXK00N -WX00KXXXXXXXK0000OOkkkkkO00OkkkkkO00000KXXXXXXXK00N -X000XXXXXK0000000OOkkkkO00OkkkkOO0000000KXXXXX0OKN -N0O0KXKK0000000000OkkkOO0OOOkkkO0000000000KKXK0OXW -WK00000000000O00000OOOOO00OOOOOO0000000000000000X -N000000000000O00000000000000000000000000000000KN -WK00OO00O000000000000000000000000O000000O00000KW -N00000000kdodkO0O00000000000000O0koc:cdO0000000XW -WK000000Oo..lO0O00000000000000k;.cO000000KN -X0000000k,.x00000000000000O0o.,k0O00000KXKKN -NKKK0OO00000Oc'x000O00OOOOO00000x,.lO000OOkkO0KXW -WNXKOkkkO0000Ol,'':x0000xc,....';dO000kl:;cdO0000OkkOKWWWW -WNNNXKOOkO000000OOO000000o.:O0000000000000OOkkkOKKKXW -NKKKKK0kkkO000000000OkkO00Od;.'ok00OxxO00000000OOkOOXWW -WNKOOO000000000k,.:xkkxc.:xOOx:.,x0OO00000OkkkO0KKXW -NKKK0OkOO00000000Od,......'::,......,oO000000000OO0XNNXXW -WNWWWN0000000000000OkollodO00OxolloxO000000000000KNW -WNK00O000000000000000000000000O000000O00000XW -WNK000000000000000000000000000000000000XNW -WNXK00000000000000000000000000000KXNW -WNNXXKK00000000000000000KKKXNNW -WWWWNNNNNNNNNNNNNWWWW - + + $ cat cat.txt | lolcat -S 1 +WNNNWWWWNXXXNW +NK0000KXWWNK000000N +WKO0000000XNWWXK00000000KW +N0O0KXXK0000XNWWX0000KKXXK00KN +WX000XXXXXK0000XWWWWWWWWWWWWWWWNK000KKXXXXXK00N +WX000XXXXXXK0000KXK000OO0000OO000KK0000KXXXXXXXK00N +WX00KXXXXXXXK0000OOkkkkkO00OkkkkkO00000KXXXXXXXK00N +X000XXXXXK0000000OOkkkkO00OkkkkOO0000000KXXXXX0OKN +N0O0KXKK0000000000OkkkOO0OOOkkkO0000000000KKXK0OXW +WK00000000000O00000OOOOO00OOOOOO0000000000000000X +N000000000000O00000000000000000000000000000000KN +WK00OO00O000000000000000000000000O000000O00000KW +N00000000kdodkO0O00000000000000O0koc:cdO0000000XW +WK000000Oo..lO0O00000000000000k;.cO000000KN +X0000000k,.x00000000000000O0o.,k0O00000KXKKN +NKKK0OO00000Oc'x000O00OOOOO00000x,.lO000OOkkO0KXW +WNXKOkkkO0000Ol,'':x0000xc,....';dO000kl:;cdO0000OkkOKWWWW +WNNNXKOOkO000000OOO000000o.:O0000000000000OOkkkOKKKXW +NKKKKK0kkkO000000000OkkO00Od;.'ok00OxxO00000000OOkOOXWW +WNKOOO000000000k,.:xkkxc.:xOOx:.,x0OO00000OkkkO0KKXW +NKKK0OkOO00000000Od,......'::,......,oO000000000OO0XNNXXW +WNWWWN0000000000000OkollodO00OxolloxO000000000000KNW +WNK00O000000000000000000000000O000000O00000XW +WNK000000000000000000000000000000000000XNW +WNXK00000000000000000000000000000KXNW +WNNXXKK00000000000000000KKKXNNW +WWWWNNNNNNNNNNNNNWWWW + diff --git a/docs/img/example-json-snippet.svg b/docs/img/example-json-snippet.svg index eb614dd..e1ccd55 100644 --- a/docs/img/example-json-snippet.svg +++ b/docs/img/example-json-snippet.svg @@ -19,90 +19,90 @@ font-weight: 700; } - .terminal-3001745814-matrix { + .terminal-481050017-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3001745814-title { + .terminal-481050017-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3001745814-r1 { fill: #f8f8f2 } -.terminal-3001745814-r2 { fill: #c5c8c6 } -.terminal-3001745814-r3 { fill: #f92672 } -.terminal-3001745814-r4 { fill: #e6db74 } + .terminal-481050017-r1 { fill: #f8f8f2 } +.terminal-481050017-r2 { fill: #c5c8c6 } +.terminal-481050017-r3 { fill: #f92672 } +.terminal-481050017-r4 { fill: #e6db74 } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -114,31 +114,31 @@ - + - - { -"menu":{ -"id":"file", -"value":"File", -"popup":{ -"menuitem":[ -{ -"value":"New", -"onclick":"CreateNewDoc()" -}, -{ -"value":"Open", -"onclick":"OpenDoc()" -}, -{ -"value":"Close", -"onclick":"CloseDoc()" -} -] -} -} -} + + { +"menu":{ +"id":"file", +"value":"File", +"popup":{ +"menuitem":[ +{ +"value":"New", +"onclick":"CreateNewDoc()" +}, +{ +"value":"Open", +"onclick":"OpenDoc()" +}, +{ +"value":"Close", +"onclick":"CloseDoc()" +} +] +} +} +} diff --git a/docs/img/example-python-snippet.svg b/docs/img/example-python-snippet.svg index b3ca1e9..c6c9553 100644 --- a/docs/img/example-python-snippet.svg +++ b/docs/img/example-python-snippet.svg @@ -19,67 +19,67 @@ font-weight: 700; } - .terminal-3363555197-matrix { + .terminal-1216513636-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3363555197-title { + .terminal-1216513636-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3363555197-r1 { fill: #f92672 } -.terminal-3363555197-r2 { fill: #f8f8f2 } -.terminal-3363555197-r3 { fill: #e6db74 } -.terminal-3363555197-r4 { fill: #c5c8c6 } -.terminal-3363555197-r5 { fill: #960050 } -.terminal-3363555197-r6 { fill: #66d9ef } -.terminal-3363555197-r7 { fill: #a6e22e } -.terminal-3363555197-r8 { fill: #ae81ff } + .terminal-1216513636-r1 { fill: #f92672 } +.terminal-1216513636-r2 { fill: #f8f8f2 } +.terminal-1216513636-r3 { fill: #e6db74 } +.terminal-1216513636-r4 { fill: #c5c8c6 } +.terminal-1216513636-r5 { fill: #960050 } +.terminal-1216513636-r6 { fill: #66d9ef } +.terminal-1216513636-r7 { fill: #a6e22e } +.terminal-1216513636-r8 { fill: #ae81ff } - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -91,22 +91,22 @@ - + - - >>>print("[italic red]Hello[/italic red] World!",locals()) -HelloWorld! -{ -'__annotations__':{}, -'__builtins__':<module'builtins'(built-in)>, -'__doc__':None, -'__loader__':<class'_frozen_importlib.BuiltinImporter'>, -'__name__':'__main__', -'__package__':None, -'__spec__':None, -'print':<functionprintat0x1027fd4c0>, -} - + + >>>print("[italic red]Hello[/italic red] World!",locals()) +HelloWorld! +{ +'__annotations__':{}, +'__builtins__':<module'builtins'(built-in)>, +'__doc__':None, +'__loader__':<class'_frozen_importlib.BuiltinImporter'>, +'__name__':'__main__', +'__package__':None, +'__spec__':None, +'print':<functionprintat0x1027fd4c0>, +} + diff --git a/docs/img/fake_command.svg b/docs/img/fake_command.svg index 347ee6c..8810836 100644 --- a/docs/img/fake_command.svg +++ b/docs/img/fake_command.svg @@ -19,30 +19,30 @@ font-weight: 700; } - .terminal-3972076290-matrix { + .terminal-138815972-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3972076290-title { + .terminal-138815972-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3972076290-r1 { fill: #c5c8c6 } + .terminal-138815972-r1 { fill: #c5c8c6 } - + - + - + @@ -54,12 +54,12 @@ - + - - $ my_tool --is-simple - -I won't tell if you don't ðŸ¤« + + $ my_tool --is-simple + +I won't tell if you don't ðŸ¤« diff --git a/docs/img/git-pull-rebase.svg b/docs/img/git-pull-rebase.svg index 81a0961..1aa10ba 100644 --- a/docs/img/git-pull-rebase.svg +++ b/docs/img/git-pull-rebase.svg @@ -19,57 +19,57 @@ font-weight: 700; } - .terminal-283955492-matrix { + .terminal-871479154-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-283955492-title { + .terminal-871479154-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-283955492-r1 { fill: #c5c8c6 } + .terminal-871479154-r1 { fill: #c5c8c6 } - + - + - + - + - + - + - + - + - + - + - + - + @@ -81,21 +81,21 @@ - + - - $ git pull --rebase                                                              - -remote: Enumerating objects: 19, done.                                           -remote: Counting objects: 100% (19/19), done.                                    -remote: Compressing objects: 100% (8/8), done.                                   -remote: Total 19 (delta 10), reused 18 (delta 9), pack-reused 0                  -Unpacking objects: 100% (19/19), 26.06 KiB | 1.45 MiB/s, done.                   -From github.com:ewels/rich-codex                                                 -5bee980..5b092fa  main       -> origin/main                                      -+ 501309f...9527197 gh-pages   -> origin/gh-pages  (forced update)               -Successfully rebased and updated refs/heads/main.                                - + + $ git pull --rebase                                                              + +remote: Enumerating objects: 19, done.                                           +remote: Counting objects: 100% (19/19), done.                                    +remote: Compressing objects: 100% (8/8), done.                                   +remote: Total 19 (delta 10), reused 18 (delta 9), pack-reused 0                  +Unpacking objects: 100% (19/19), 26.06 KiB | 1.45 MiB/s, done.                   +From github.com:ewels/rich-codex                                                 +5bee980..5b092fa  main       -> origin/main                                      ++ 501309f...9527197 gh-pages   -> origin/gh-pages  (forced update)               +Successfully rebased and updated refs/heads/main.                                + diff --git a/docs/img/git-push-error.svg b/docs/img/git-push-error.svg index e6ce73f..f7c788b 100644 --- a/docs/img/git-push-error.svg +++ b/docs/img/git-push-error.svg @@ -19,56 +19,56 @@ font-weight: 700; } - .terminal-575712878-matrix { + .terminal-3321402471-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-575712878-title { + .terminal-3321402471-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-575712878-r1 { fill: #c5c8c6 } -.terminal-575712878-r2 { fill: #cc555a } -.terminal-575712878-r3 { fill: #d0b344 } + .terminal-3321402471-r1 { fill: #c5c8c6 } +.terminal-3321402471-r2 { fill: #cc555a } +.terminal-3321402471-r3 { fill: #d0b344 } - + - + - + - + - + - + - + - + - + - + - + @@ -80,20 +80,20 @@ - + - - $ git push - -To github.com:ewels/rich-codex.git -!         main -> main (fetch first) -error: failed to push some refs to 'github.com:ewels/rich-codex.git' -hint: Updates were rejected because the remote contains work that you do -hint: not have locally. This is usually caused by another repository pushing -hint: to the same ref. You may want to first integrate the remote changes -hint: (e.g., 'git pull ...') before pushing again. -hint: See the 'Note about fast-forwards' in 'git push --help' for details. - + + $ git push + +To github.com:ewels/rich-codex.git +!         main -> main (fetch first) +error: failed to push some refs to 'github.com:ewels/rich-codex.git' +hint: Updates were rejected because the remote contains work that you do +hint: not have locally. This is usually caused by another repository pushing +hint: to the same ref. You may want to first integrate the remote changes +hint: (e.g., 'git pull ...') before pushing again. +hint: See the 'Note about fast-forwards' in 'git push --help' for details. + diff --git a/docs/img/git-push-success.svg b/docs/img/git-push-success.svg index 89d2be0..200e0bf 100644 --- a/docs/img/git-push-success.svg +++ b/docs/img/git-push-success.svg @@ -19,57 +19,57 @@ font-weight: 700; } - .terminal-42387152-matrix { + .terminal-3132992798-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-42387152-title { + .terminal-3132992798-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-42387152-r1 { fill: #c5c8c6 } + .terminal-3132992798-r1 { fill: #c5c8c6 } - + - + - + - + - + - + - + - + - + - + - + - + @@ -81,21 +81,21 @@ - + - - $ git push                                                                       - -Enumerating objects: 13, done.                                                   -Counting objects: 100% (13/13), done.                                            -Delta compression using up to 10 threads                                         -Compressing objects: 100% (6/6), done.                                           -Writing objects: 100% (7/7), 608 bytes | 608.00 KiB/s, done.                     -Total 7 (delta 5), reused 0 (delta 0), pack-reused 0                             -remote: Resolving deltas: 100% (5/5), completed with 5 local objects.            -To github.com:ewels/rich-codex.git                                               -fbbec47..482c318  main -> main                                                   - + + $ git push                                                                       + +Enumerating objects: 13, done.                                                   +Counting objects: 100% (13/13), done.                                            +Delta compression using up to 10 threads                                         +Compressing objects: 100% (6/6), done.                                           +Writing objects: 100% (7/7), 608 bytes | 608.00 KiB/s, done.                     +Total 7 (delta 5), reused 0 (delta 0), pack-reused 0                             +remote: Resolving deltas: 100% (5/5), completed with 5 local objects.            +To github.com:ewels/rich-codex.git                                               +fbbec47..482c318  main -> main                                                   + diff --git a/docs/img/head-tail.svg b/docs/img/head-tail.svg index 18006fb..9296028 100644 --- a/docs/img/head-tail.svg +++ b/docs/img/head-tail.svg @@ -19,116 +19,116 @@ font-weight: 700; } - .terminal-3045053978-matrix { + .terminal-1650489693-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3045053978-title { + .terminal-1650489693-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3045053978-r1 { fill: #c5c8c6 } -.terminal-3045053978-r2 { fill: #868887;font-style: italic; } + .terminal-1650489693-r1 { fill: #c5c8c6 } +.terminal-1650489693-r2 { fill: #868887;font-style: italic; } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - codex_search.py + codex_search.py - + - - $ rich ../../src/rich_codex/codex_search.py -import logging -import re -from pathlib import Path - -import yaml -from jsonschema.exceptions import ValidationError -from rich import box -from rich.console import Console -from rich.prompt import Prompt -from rich.table import Table -[..truncated..] -        """Save the images that we have collected.""" -        for img_obj in self.rich_imgs: -            img_obj.get_output() -            img_obj.save_images() -            self.saved_img_paths += img_obj.saved_img_paths -            self.num_img_saved += img_obj.num_img_saved -            self.num_img_skipped += img_obj.num_img_skipped - + + $ rich ../../src/rich_codex/codex_search.py +import logging +import re +from pathlib import Path + +import yaml +from jsonschema.exceptions import ValidationError +from rich import box +from rich.console import Console +from rich.prompt import Prompt +from rich.table import Table +[..truncated..] +        """Save the images that we have collected.""" +        for img_obj in self.rich_imgs: +            img_obj.get_output() +            img_obj.save_images() +            self.saved_img_paths += img_obj.saved_img_paths +            self.num_img_saved += img_obj.num_img_saved +            self.num_img_skipped += img_obj.num_img_skipped + diff --git a/docs/img/hide-command-default.svg b/docs/img/hide-command-default.svg index 17a4cc4..ca87f1b 100644 --- a/docs/img/hide-command-default.svg +++ b/docs/img/hide-command-default.svg @@ -19,27 +19,27 @@ font-weight: 700; } - .terminal-1591417746-matrix { + .terminal-3153537754-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1591417746-title { + .terminal-3153537754-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1591417746-r1 { fill: #c5c8c6 } + .terminal-3153537754-r1 { fill: #c5c8c6 } - + - + @@ -51,11 +51,11 @@ - + - - $ echo "See the command printed at the top?" -See the command printed at the top? + + $ echo "See the command printed at the top?" +See the command printed at the top? diff --git a/docs/img/hide-command.svg b/docs/img/hide-command.svg index c54e61a..38278e3 100644 --- a/docs/img/hide-command.svg +++ b/docs/img/hide-command.svg @@ -19,24 +19,24 @@ font-weight: 700; } - .terminal-599002538-matrix { + .terminal-3229357380-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-599002538-title { + .terminal-3229357380-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-599002538-r1 { fill: #c5c8c6 } + .terminal-3229357380-r1 { fill: #c5c8c6 } - + @@ -49,10 +49,10 @@ - + - - What command was used? It's a mystery.. + + What command was used? It's a mystery.. diff --git a/docs/img/rich-codex-cli-envs.svg b/docs/img/rich-codex-cli-envs.svg index 23a8371..78a7c47 100644 --- a/docs/img/rich-codex-cli-envs.svg +++ b/docs/img/rich-codex-cli-envs.svg @@ -19,178 +19,178 @@ font-weight: 700; } - .terminal-168012088-matrix { + .terminal-323379314-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-168012088-title { + .terminal-323379314-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-168012088-r1 { fill: #c5c8c6 } -.terminal-168012088-r2 { fill: #c5c8c6;font-weight: bold } -.terminal-168012088-r3 { fill: #d0b344;font-weight: bold } -.terminal-168012088-r4 { fill: #68a0b3;font-weight: bold } -.terminal-168012088-r5 { fill: #868887 } -.terminal-168012088-r6 { fill: #8d7b39 } -.terminal-168012088-r7 { fill: #8d7b39;font-weight: bold } -.terminal-168012088-r8 { fill: #98a84b;font-weight: bold } + .terminal-323379314-r1 { fill: #c5c8c6 } +.terminal-323379314-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-323379314-r3 { fill: #d0b344;font-weight: bold } +.terminal-323379314-r4 { fill: #68a0b3;font-weight: bold } +.terminal-323379314-r5 { fill: #868887 } +.terminal-323379314-r6 { fill: #8d7b39 } +.terminal-323379314-r7 { fill: #8d7b39;font-weight: bold } +.terminal-323379314-r8 { fill: #98a84b;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -202,59 +202,59 @@ - + - - $ rich-codex --help - -Usage: rich-codex [OPTIONS] - - Create rich code images for your docs.                                                                                  - -╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® -│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ -│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ -│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ -│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ -│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ -│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ -│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ -│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ -│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ -│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ -│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ -│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ -│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ -│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ -│--hide-command[env: HIDE_COMMAND]                                               â”‚ -│                                       Hide the terminal prompt with the command at the top of the output             â”‚ -│--title-command[env: TITLE_COMMAND]                                       â”‚ -│                                       Use the command as the terminal title if not set explicitly                    â”‚ -│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ -│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ -│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ -│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ -│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ -│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ -│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ -│[default: 0]       â”‚ -│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ -│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ -│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ -│[default: 80]            â”‚ -│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ -│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ -│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ -│--use-pty[env: USE_PTY]                                                  â”‚ -│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ -│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ -│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ -│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ -│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ -│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ -│--help  Show this message and exit.                                                    â”‚ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + $ rich-codex --help + +Usage: rich-codex [OPTIONS] + + Create rich code images for your docs.                                                                                  + +╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® +│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ +│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ +│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ +│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ +│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ +│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ +│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ +│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ +│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ +│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ +│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ +│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ +│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ +│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ +│--hide-command[env: HIDE_COMMAND]                                               â”‚ +│                                       Hide the terminal prompt with the command at the top of the output             â”‚ +│--title-command[env: TITLE_COMMAND]                                       â”‚ +│                                       Use the command as the terminal title if not set explicitly                    â”‚ +│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ +│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ +│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ +│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ +│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ +│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ +│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ +│[default: 0]       â”‚ +│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ +│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ +│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ +│[default: 80]            â”‚ +│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ +│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ +│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ +│--use-pty[env: USE_PTY]                                                  â”‚ +│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ +│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ +│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ +│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ +│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ +│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ +│--help  Show this message and exit.                                                    â”‚ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/docs/img/rich-codex-cli-help.svg b/docs/img/rich-codex-cli-help.svg index 23a8371..78a7c47 100644 --- a/docs/img/rich-codex-cli-help.svg +++ b/docs/img/rich-codex-cli-help.svg @@ -19,178 +19,178 @@ font-weight: 700; } - .terminal-168012088-matrix { + .terminal-323379314-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-168012088-title { + .terminal-323379314-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-168012088-r1 { fill: #c5c8c6 } -.terminal-168012088-r2 { fill: #c5c8c6;font-weight: bold } -.terminal-168012088-r3 { fill: #d0b344;font-weight: bold } -.terminal-168012088-r4 { fill: #68a0b3;font-weight: bold } -.terminal-168012088-r5 { fill: #868887 } -.terminal-168012088-r6 { fill: #8d7b39 } -.terminal-168012088-r7 { fill: #8d7b39;font-weight: bold } -.terminal-168012088-r8 { fill: #98a84b;font-weight: bold } + .terminal-323379314-r1 { fill: #c5c8c6 } +.terminal-323379314-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-323379314-r3 { fill: #d0b344;font-weight: bold } +.terminal-323379314-r4 { fill: #68a0b3;font-weight: bold } +.terminal-323379314-r5 { fill: #868887 } +.terminal-323379314-r6 { fill: #8d7b39 } +.terminal-323379314-r7 { fill: #8d7b39;font-weight: bold } +.terminal-323379314-r8 { fill: #98a84b;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -202,59 +202,59 @@ - + - - $ rich-codex --help - -Usage: rich-codex [OPTIONS] - - Create rich code images for your docs.                                                                                  - -╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® -│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ -│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ -│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ -│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ -│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ -│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ -│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ -│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ -│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ -│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ -│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ -│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ -│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ -│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ -│--hide-command[env: HIDE_COMMAND]                                               â”‚ -│                                       Hide the terminal prompt with the command at the top of the output             â”‚ -│--title-command[env: TITLE_COMMAND]                                       â”‚ -│                                       Use the command as the terminal title if not set explicitly                    â”‚ -│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ -│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ -│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ -│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ -│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ -│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ -│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ -│[default: 0]       â”‚ -│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ -│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ -│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ -│[default: 80]            â”‚ -│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ -│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ -│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ -│--use-pty[env: USE_PTY]                                                  â”‚ -│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ -│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ -│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ -│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ -│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ -│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ -│--help  Show this message and exit.                                                    â”‚ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + $ rich-codex --help + +Usage: rich-codex [OPTIONS] + + Create rich code images for your docs.                                                                                  + +╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® +│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ +│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ +│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ +│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ +│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ +│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ +│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ +│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ +│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ +│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ +│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ +│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ +│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ +│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ +│--hide-command[env: HIDE_COMMAND]                                               â”‚ +│                                       Hide the terminal prompt with the command at the top of the output             â”‚ +│--title-command[env: TITLE_COMMAND]                                       â”‚ +│                                       Use the command as the terminal title if not set explicitly                    â”‚ +│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ +│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ +│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ +│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ +│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ +│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ +│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ +│[default: 0]       â”‚ +│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ +│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ +│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ +│[default: 80]            â”‚ +│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ +│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ +│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ +│--use-pty[env: USE_PTY]                                                  â”‚ +│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ +│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ +│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ +│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ +│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ +│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ +│--help  Show this message and exit.                                                    â”‚ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/docs/img/rich-codex-help-min-pct.svg b/docs/img/rich-codex-help-min-pct.svg index 860c0b5..1bcbb34 100644 --- a/docs/img/rich-codex-help-min-pct.svg +++ b/docs/img/rich-codex-help-min-pct.svg @@ -19,340 +19,340 @@ font-weight: 700; } - .terminal-1550781362-matrix { + .terminal-107205559-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1550781362-title { + .terminal-107205559-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1550781362-r1 { fill: #c5c8c6 } -.terminal-1550781362-r2 { fill: #c5c8c6;font-weight: bold } -.terminal-1550781362-r3 { fill: #d0b344;font-weight: bold } -.terminal-1550781362-r4 { fill: #868887 } -.terminal-1550781362-r5 { fill: #68a0b3;font-weight: bold } -.terminal-1550781362-r6 { fill: #8d7b39 } -.terminal-1550781362-r7 { fill: #8d7b39;font-weight: bold } -.terminal-1550781362-r8 { fill: #98a84b;font-weight: bold } + .terminal-107205559-r1 { fill: #c5c8c6 } +.terminal-107205559-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-107205559-r3 { fill: #d0b344;font-weight: bold } +.terminal-107205559-r4 { fill: #68a0b3;font-weight: bold } +.terminal-107205559-r5 { fill: #868887 } +.terminal-107205559-r6 { fill: #8d7b39 } +.terminal-107205559-r7 { fill: #8d7b39;font-weight: bold } +.terminal-107205559-r8 { fill: #98a84b;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -364,113 +364,113 @@ - + - - $ rich-codex --help - -Usage: rich-codex [OPTIONS] - - Create rich code images for your docs.                                          - -╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® -│--search-includeTEXT      [env: SEARCH_INCLUDE]                 â”‚ -│                                       Glob patterns to search for rich-codex â”‚ -│                                       comments                               â”‚ -│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                 â”‚ -│                                       Glob patterns to exclude from search   â”‚ -│                                       for rich-codex comments                â”‚ -│--no-search[env: NO_SEARCH]                      â”‚ -│                                       Set to disable searching for           â”‚ -│                                       rich-codex comments                    â”‚ -│--commandTEXT      [env: COMMAND]                        â”‚ -│                                       Specify a command to run to capture    â”‚ -│                                       output                                 â”‚ -│--timeoutINTEGER   [env: TIMEOUT]                        â”‚ -│                                       Maximum run time for command (seconds) â”‚ -│[default: 5]                          â”‚ -│--before-commandTEXT      [env: BEFORE_COMMAND]                 â”‚ -│                                       Setup commands to run before running   â”‚ -│                                       main output command                    â”‚ -│--after-commandTEXT      [env: AFTER_COMMAND]                  â”‚ -│                                       Setup commands to run after running    â”‚ -│                                       main output command                    â”‚ -│--snippetTEXT      [env: SNIPPET]                â”‚ -│                                       Literal code snippet to render         â”‚ -│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX]                 â”‚ -│                                       Language to use for snippet sytax      â”‚ -│                                       highlighting                           â”‚ -│--img-pathsTEXT      [env: IMG_PATHS]                      â”‚ -│                                       Path to image filenames if using       â”‚ -│                                       'command' or 'snippet'                 â”‚ -│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS]                â”‚ -│                                       Remove any matching files that are not â”‚ -│                                       generated                              â”‚ -│--configsTEXT      [env: RC_CONFIGS]         â”‚ -│                                       Paths to YAML config files             â”‚ -│--fake-commandTEXT      [env: FAKE_COMMAND]                   â”‚ -│                                       Pretend command to show in the         â”‚ -│                                       screenshot prompt                      â”‚ -│--hide-command[env: HIDE_COMMAND]                   â”‚ -│                                       Hide the terminal prompt with the      â”‚ -│                                       command at the top of the output       â”‚ -│--title-command[env: TITLE_COMMAND]                  â”‚ -│                                       Use the command as the terminal title  â”‚ -│                                       if not set explicitly                  â”‚ -│--headINTEGER   [env: RC_HEAD]                       â”‚ -│                                       Show only the first N lines of output  â”‚ -│--tailINTEGER   [env: RC_TAIL]                      â”‚ -│                                       Show only the last N lines of output   â”‚ -│--trim-afterTEXT      [env: TRIM_AFTER]                     â”‚ -│                                       Don't print any more lines after this  â”‚ -│                                       string is found                        â”‚ -│--truncated-textTEXT      [env: TRUNCATED_TEXT]                 â”‚ -│                                       Text to show when --head or --tail│ -│                                       truncate content                       â”‚ -│--skip-git-checks[env: SKIP_GIT_CHECKS]          â”‚ -│                                       Skip safety checks for git repos       â”‚ -│--no-confirm[env: NO_CONFIRM]                     â”‚ -│                                       Set to skip confirmation prompt before â”‚ -│                                       running commands                       â”‚ -│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF]                   â”‚ -│                                       Minimum file percentage change         â”‚ -│                                       required to update image               â”‚ -│[default: 0]                          â”‚ -│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX]              â”‚ -│                                       Skip image update if file changes      â”‚ -│                                       match regex                            â”‚ -│--terminal-widthTEXT      [env: TERMINAL_WIDTH]│ -│                                       Width of the terminal                  â”‚ -│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH]             â”‚ -│                                       Minimum width of the terminal when     â”‚ -│                                       trimming                               â”‚ -│[default: 80]                         â”‚ -│--notrim[env: NOTRIM]                         â”‚ -│                                       Disable automatic trimming of terminal â”‚ -│                                       width                                  â”‚ -│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme     â”‚ -│--snippet-themeTEXT      [env: SNIPPET_THEME]  â”‚ -│                                       Snippet Pygments theme                 â”‚ -│--use-pty[env: USE_PTY]                        â”‚ -│                                       Use a pseudo-terminal for commands     â”‚ -│                                       (may capture coloured output)          â”‚ -│--created-files<filename>[env: CREATED_FILES]                  â”‚ -│                                       Save a list of created files to this   â”‚ -│                                       file                                   â”‚ -│--deleted-files<filename>[env: DELETED_FILES]                  â”‚ -│                                       Save a list of deleted files to this   â”‚ -│                                       file                                   â”‚ -│--verbose-v[env: LOG_VERBOSE]                  â”‚ -│                                       Print verbose output to the console.   â”‚ -│--save-log<filename>[env: LOG_SAVE]                       â”‚ -│                                       Save a verbose log to a file           â”‚ -│                                       (automatic filename).                  â”‚ -│--log-file-l<filename>[env: LOG_FILENAME]                   â”‚ -│                                       Save a verbose log to a file (specific â”‚ -│                                       filename).                             â”‚ -│--help  Show this message and exit.            â”‚ -╰──────────────────────────────────────────────────────────────────────────────╯ - + + $ rich-codex --help + +Usage: rich-codex [OPTIONS] + + Create rich code images for your docs.                                          + +╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® +│--search-includeTEXT      [env: SEARCH_INCLUDE]                 â”‚ +│                                       Glob patterns to search for rich-codex â”‚ +│                                       comments                               â”‚ +│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                 â”‚ +│                                       Glob patterns to exclude from search   â”‚ +│                                       for rich-codex comments                â”‚ +│--no-search[env: NO_SEARCH]                      â”‚ +│                                       Set to disable searching for           â”‚ +│                                       rich-codex comments                    â”‚ +│--commandTEXT      [env: COMMAND]                        â”‚ +│                                       Specify a command to run to capture    â”‚ +│                                       output                                 â”‚ +│--timeoutINTEGER   [env: TIMEOUT]                        â”‚ +│                                       Maximum run time for command (seconds) â”‚ +│[default: 5]                          â”‚ +│--before-commandTEXT      [env: BEFORE_COMMAND]                 â”‚ +│                                       Setup commands to run before running   â”‚ +│                                       main output command                    â”‚ +│--after-commandTEXT      [env: AFTER_COMMAND]                  â”‚ +│                                       Setup commands to run after running    â”‚ +│                                       main output command                    â”‚ +│--snippetTEXT      [env: SNIPPET]                â”‚ +│                                       Literal code snippet to render         â”‚ +│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX]                 â”‚ +│                                       Language to use for snippet sytax      â”‚ +│                                       highlighting                           â”‚ +│--img-pathsTEXT      [env: IMG_PATHS]                      â”‚ +│                                       Path to image filenames if using       â”‚ +│                                       'command' or 'snippet'                 â”‚ +│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS]                â”‚ +│                                       Remove any matching files that are not â”‚ +│                                       generated                              â”‚ +│--configsTEXT      [env: RC_CONFIGS]         â”‚ +│                                       Paths to YAML config files             â”‚ +│--fake-commandTEXT      [env: FAKE_COMMAND]                   â”‚ +│                                       Pretend command to show in the         â”‚ +│                                       screenshot prompt                      â”‚ +│--hide-command[env: HIDE_COMMAND]                   â”‚ +│                                       Hide the terminal prompt with the      â”‚ +│                                       command at the top of the output       â”‚ +│--title-command[env: TITLE_COMMAND]                  â”‚ +│                                       Use the command as the terminal title  â”‚ +│                                       if not set explicitly                  â”‚ +│--headINTEGER   [env: RC_HEAD]                       â”‚ +│                                       Show only the first N lines of output  â”‚ +│--tailINTEGER   [env: RC_TAIL]                      â”‚ +│                                       Show only the last N lines of output   â”‚ +│--trim-afterTEXT      [env: TRIM_AFTER]                     â”‚ +│                                       Don't print any more lines after this  â”‚ +│                                       string is found                        â”‚ +│--truncated-textTEXT      [env: TRUNCATED_TEXT]                 â”‚ +│                                       Text to show when --head or --tail│ +│                                       truncate content                       â”‚ +│--skip-git-checks[env: SKIP_GIT_CHECKS]          â”‚ +│                                       Skip safety checks for git repos       â”‚ +│--no-confirm[env: NO_CONFIRM]                     â”‚ +│                                       Set to skip confirmation prompt before â”‚ +│                                       running commands                       â”‚ +│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF]                   â”‚ +│                                       Minimum file percentage change         â”‚ +│                                       required to update image               â”‚ +│[default: 0]                          â”‚ +│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX]              â”‚ +│                                       Skip image update if file changes      â”‚ +│                                       match regex                            â”‚ +│--terminal-widthTEXT      [env: TERMINAL_WIDTH]│ +│                                       Width of the terminal                  â”‚ +│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH]             â”‚ +│                                       Minimum width of the terminal when     â”‚ +│                                       trimming                               â”‚ +│[default: 80]                         â”‚ +│--notrim[env: NOTRIM]                         â”‚ +│                                       Disable automatic trimming of terminal â”‚ +│                                       width                                  â”‚ +│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme     â”‚ +│--snippet-themeTEXT      [env: SNIPPET_THEME]  â”‚ +│                                       Snippet Pygments theme                 â”‚ +│--use-pty[env: USE_PTY]                        â”‚ +│                                       Use a pseudo-terminal for commands     â”‚ +│                                       (may capture coloured output)          â”‚ +│--created-files<filename>[env: CREATED_FILES]                  â”‚ +│                                       Save a list of created files to this   â”‚ +│                                       file                                   â”‚ +│--deleted-files<filename>[env: DELETED_FILES]                  â”‚ +│                                       Save a list of deleted files to this   â”‚ +│                                       file                                   â”‚ +│--verbose-v[env: LOG_VERBOSE]                  â”‚ +│                                       Print verbose output to the console.   â”‚ +│--save-log<filename>[env: LOG_SAVE]                       â”‚ +│                                       Save a verbose log to a file           â”‚ +│                                       (automatic filename).                  â”‚ +│--log-file-l<filename>[env: LOG_FILENAME]                   â”‚ +│                                       Save a verbose log to a file (specific â”‚ +│                                       filename).                             â”‚ +│--help  Show this message and exit.            â”‚ +╰──────────────────────────────────────────────────────────────────────────────╯ + diff --git a/docs/img/rich-codex-help.svg b/docs/img/rich-codex-help.svg index 23a8371..78a7c47 100644 --- a/docs/img/rich-codex-help.svg +++ b/docs/img/rich-codex-help.svg @@ -19,178 +19,178 @@ font-weight: 700; } - .terminal-168012088-matrix { + .terminal-323379314-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-168012088-title { + .terminal-323379314-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-168012088-r1 { fill: #c5c8c6 } -.terminal-168012088-r2 { fill: #c5c8c6;font-weight: bold } -.terminal-168012088-r3 { fill: #d0b344;font-weight: bold } -.terminal-168012088-r4 { fill: #68a0b3;font-weight: bold } -.terminal-168012088-r5 { fill: #868887 } -.terminal-168012088-r6 { fill: #8d7b39 } -.terminal-168012088-r7 { fill: #8d7b39;font-weight: bold } -.terminal-168012088-r8 { fill: #98a84b;font-weight: bold } + .terminal-323379314-r1 { fill: #c5c8c6 } +.terminal-323379314-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-323379314-r3 { fill: #d0b344;font-weight: bold } +.terminal-323379314-r4 { fill: #68a0b3;font-weight: bold } +.terminal-323379314-r5 { fill: #868887 } +.terminal-323379314-r6 { fill: #8d7b39 } +.terminal-323379314-r7 { fill: #8d7b39;font-weight: bold } +.terminal-323379314-r8 { fill: #98a84b;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -202,59 +202,59 @@ - + - - $ rich-codex --help - -Usage: rich-codex [OPTIONS] - - Create rich code images for your docs.                                                                                  - -╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® -│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ -│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ -│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ -│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ -│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ -│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ -│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ -│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ -│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ -│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ -│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ -│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ -│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ -│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ -│--hide-command[env: HIDE_COMMAND]                                               â”‚ -│                                       Hide the terminal prompt with the command at the top of the output             â”‚ -│--title-command[env: TITLE_COMMAND]                                       â”‚ -│                                       Use the command as the terminal title if not set explicitly                    â”‚ -│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ -│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ -│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ -│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ -│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ -│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ -│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ -│[default: 0]       â”‚ -│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ -│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ -│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ -│[default: 80]            â”‚ -│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ -│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ -│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ -│--use-pty[env: USE_PTY]                                                  â”‚ -│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ -│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ -│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ -│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ -│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ -│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ -│--help  Show this message and exit.                                                    â”‚ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + $ rich-codex --help + +Usage: rich-codex [OPTIONS] + + Create rich code images for your docs.                                                                                  + +╭─ Options â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â”€â•® +│--search-includeTEXT      [env: SEARCH_INCLUDE] Glob patterns to search for rich-codex comments          â”‚ +│--search-excludeTEXT      [env: SEARCH_EXCLUDE]                                       â”‚ +│                                       Glob patterns to exclude from search for rich-codex comments                   â”‚ +│--no-search[env: NO_SEARCH] Set to disable searching for rich-codex comments              â”‚ +│--commandTEXT      [env: COMMAND] Specify a command to run to capture output                      â”‚ +│--timeoutINTEGER   [env: TIMEOUT] Maximum run time for command (seconds) [default: 5]│ +│--before-commandTEXT      [env: BEFORE_COMMAND] Setup commands to run before running main output command â”‚ +│--after-commandTEXT      [env: AFTER_COMMAND] Setup commands to run after running main output command   â”‚ +│--snippetTEXT      [env: SNIPPET] Literal code snippet to render                                  â”‚ +│--snippet-syntaxTEXT      [env: SNIPPET_SYNTAX] Language to use for snippet sytax highlighting           â”‚ +│--img-pathsTEXT      [env: IMG_PATHS] Path to image filenames if using 'command' or 'snippet'       â”‚ +│--clean-img-pathsTEXT      [env: CLEAN_IMG_PATHS] Remove any matching files that are not generated        â”‚ +│--configsTEXT      [env: RC_CONFIGS] Paths to YAML config files                                   â”‚ +│--fake-commandTEXT      [env: FAKE_COMMAND] Pretend command to show in the screenshot prompt           â”‚ +│--hide-command[env: HIDE_COMMAND]                                               â”‚ +│                                       Hide the terminal prompt with the command at the top of the output             â”‚ +│--title-command[env: TITLE_COMMAND]                                       â”‚ +│                                       Use the command as the terminal title if not set explicitly                    â”‚ +│--headINTEGER   [env: RC_HEAD] Show only the first N lines of output                           â”‚ +│--tailINTEGER   [env: RC_TAIL] Show only the last N lines of output                            â”‚ +│--trim-afterTEXT      [env: TRIM_AFTER] Don't print any more lines after this string is found        â”‚ +│--truncated-textTEXT      [env: TRUNCATED_TEXT] Text to show when --head or --tail truncate content      â”‚ +│--skip-git-checks[env: SKIP_GIT_CHECKS] Skip safety checks for git repos                        â”‚ +│--no-confirm[env: NO_CONFIRM] Set to skip confirmation prompt before running commands      â”‚ +│--min-pct-diffFLOAT     [env: MIN_PCT_DIFF] Minimum file percentage change required to update image    â”‚ +│[default: 0]       â”‚ +│--skip-change-regexTEXT      [env: SKIP_CHANGE_REGEX] Skip image update if file changes match regex         â”‚ +│--terminal-widthTEXT      [env: TERMINAL_WIDTH] Width of the terminal                                    â”‚ +│--terminal-min-widthINTEGER   [env: TERMINAL_MIN_WIDTH] Minimum width of the terminal when trimming          â”‚ +│[default: 80]            â”‚ +│--notrim[env: NOTRIM] Disable automatic trimming of terminal width                     â”‚ +│--terminal-themeTEXT      [env: TERMINAL_THEME] Colour theme                                             â”‚ +│--snippet-themeTEXT      [env: SNIPPET_THEME] Snippet Pygments theme                                    â”‚ +│--use-pty[env: USE_PTY]                                                  â”‚ +│                                       Use a pseudo-terminal for commands (may capture coloured output)               â”‚ +│--created-files<filename>[env: CREATED_FILES] Save a list of created files to this file                 â”‚ +│--deleted-files<filename>[env: DELETED_FILES] Save a list of deleted files to this file                 â”‚ +│--verbose-v[env: LOG_VERBOSE] Print verbose output to the console.                        â”‚ +│--save-log<filename>[env: LOG_SAVE] Save a verbose log to a file (automatic filename).             â”‚ +│--log-file-l<filename>[env: LOG_FILENAME] Save a verbose log to a file (specific filename).          â”‚ +│--help  Show this message and exit.                                                    â”‚ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/docs/img/rich-codex-snippet-title.svg b/docs/img/rich-codex-snippet-title.svg index 20d6afe..f16cb27 100644 --- a/docs/img/rich-codex-snippet-title.svg +++ b/docs/img/rich-codex-snippet-title.svg @@ -19,134 +19,134 @@ font-weight: 700; } - .terminal-1570596213-matrix { + .terminal-1411256956-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1570596213-title { + .terminal-1411256956-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1570596213-r1 { fill: #98729f } -.terminal-1570596213-r2 { fill: #c5c8c6 } -.terminal-1570596213-r3 { fill: #7a7c7d } -.terminal-1570596213-r4 { fill: #fdfdc5 } -.terminal-1570596213-r5 { fill: #ff2627 } -.terminal-1570596213-r6 { fill: #d08442 } -.terminal-1570596213-r7 { fill: #398280 } -.terminal-1570596213-r8 { fill: #9a9b99 } + .terminal-1411256956-r1 { fill: #98729f } +.terminal-1411256956-r2 { fill: #c5c8c6 } +.terminal-1411256956-r3 { fill: #7a7c7d } +.terminal-1411256956-r4 { fill: #fdfdc5 } +.terminal-1411256956-r5 { fill: #ff2627 } +.terminal-1411256956-r6 { fill: #d08442 } +.terminal-1411256956-r7 { fill: #398280 } +.terminal-1411256956-r8 { fill: #9a9b99 } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - rich_img.py + rich_img.py - + - - ╭──────────────────────────────────────────────────────────────────────────────╮ -││   â”‚   â”‚   â”‚   â”‚   svg2pdf(│ -││   â”‚   â”‚   â”‚   â”‚   â”‚   file_obj=open(svg_tmp_filename,"rb"),│ -││   â”‚   â”‚   â”‚   â”‚   â”‚   write_to=tmp_filename,│ -││   â”‚   â”‚   â”‚   â”‚   )│ -││   â”‚   â”‚   â”‚   â”‚   ifself._enough_image_difference(tmp_filename,│ -│filename):│ -││   â”‚   â”‚   â”‚   â”‚   â”‚   copyfile(tmp_filename,filename)│ -││   â”‚   â”‚   â”‚   â”‚   â”‚   pdf_img=filename│ -││   â”‚   â”‚   â”‚ -││   â”‚   â”‚   # Delete temprary files│ -││   â”‚   â”‚   tmp_path=Path(tmp_filename)│ -││   â”‚   â”‚   ifPath(gettempdir())intmp_path.resolve().parents:│ -││   â”‚   â”‚   â”‚   os.close(tmp_file_handle)│ -││   â”‚   â”‚   â”‚   tmp_path.unlink()│ -││   â”‚   â”‚ -││   â”‚   # Delete temporary SVG file - after loop as can be reused│ -││   â”‚   tmp_svg_path=Path(svg_tmp_filename)│ -││   â”‚   ifPath(gettempdir())intmp_svg_path.resolve().parents:│ -││   â”‚   â”‚   os.close(svg_tmp_file_handle)│ -││   â”‚   â”‚   tmp_svg_path.unlink()│ -││ -╰──────────────────────────────────────────────────────────────────────────────╯ + + ╭──────────────────────────────────────────────────────────────────────────────╮ +││   â”‚   â”‚   â”‚   â”‚   svg2pdf(│ +││   â”‚   â”‚   â”‚   â”‚   â”‚   file_obj=open(svg_tmp_filename,"rb"),│ +││   â”‚   â”‚   â”‚   â”‚   â”‚   write_to=tmp_filename,│ +││   â”‚   â”‚   â”‚   â”‚   )│ +││   â”‚   â”‚   â”‚   â”‚   ifself._enough_image_difference(tmp_filename,│ +│filename):│ +││   â”‚   â”‚   â”‚   â”‚   â”‚   copyfile(tmp_filename,filename)│ +││   â”‚   â”‚   â”‚   â”‚   â”‚   pdf_img=filename│ +││   â”‚   â”‚   â”‚ +││   â”‚   â”‚   # Delete temprary files│ +││   â”‚   â”‚   tmp_path=Path(tmp_filename)│ +││   â”‚   â”‚   ifPath(gettempdir())intmp_path.resolve().parents:│ +││   â”‚   â”‚   â”‚   os.close(tmp_file_handle)│ +││   â”‚   â”‚   â”‚   tmp_path.unlink()│ +││   â”‚   â”‚ +││   â”‚   # Delete temporary SVG file - after loop as can be reused│ +││   â”‚   tmp_svg_path=Path(svg_tmp_filename)│ +││   â”‚   ifPath(gettempdir())intmp_svg_path.resolve().parents:│ +││   â”‚   â”‚   os.close(svg_tmp_file_handle)│ +││   â”‚   â”‚   tmp_svg_path.unlink()│ +││ +╰──────────────────────────────────────────────────────────────────────────────╯ diff --git a/docs/img/rich-codex-snippet.svg b/docs/img/rich-codex-snippet.svg index 696b7d1..3fc7b7b 100644 --- a/docs/img/rich-codex-snippet.svg +++ b/docs/img/rich-codex-snippet.svg @@ -19,86 +19,86 @@ font-weight: 700; } - .terminal-4243514251-matrix { + .terminal-982039795-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-4243514251-title { + .terminal-982039795-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-4243514251-r1 { fill: #c5c8c6 } -.terminal-4243514251-r2 { fill: #398280 } -.terminal-4243514251-r3 { fill: #d0b344 } -.terminal-4243514251-r4 { fill: #1984e9 } -.terminal-4243514251-r5 { fill: #868887 } -.terminal-4243514251-r6 { fill: #ff2c7a } + .terminal-982039795-r1 { fill: #c5c8c6 } +.terminal-982039795-r2 { fill: #398280 } +.terminal-982039795-r3 { fill: #d0b344 } +.terminal-982039795-r4 { fill: #1984e9 } +.terminal-982039795-r5 { fill: #868887 } +.terminal-982039795-r6 { fill: #ff2c7a } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -110,29 +110,29 @@ - + - -                     svg2pdf( -                        file_obj=open(svg_tmp_filename, "rb"), -                        write_to=tmp_filename, -                    ) -ifself._enough_image_difference(tmp_filename, filename): -                        copyfile(tmp_filename, filename) -                        pdf_img = filename - -# Delete temprary files -            tmp_path = Path(tmp_filename) -if Path(gettempdir()) in tmp_path.resolve().parents: -                os.close(tmp_file_handle) -                tmp_path.unlink() - -# Delete temporary SVG file - after loop as can be reused -        tmp_svg_path = Path(svg_tmp_filename) -if Path(gettempdir()) in tmp_svg_path.resolve().parents: -            os.close(svg_tmp_file_handle) -            tmp_svg_path.unlink() - + +                     svg2pdf( +                        file_obj=open(svg_tmp_filename, "rb"), +                        write_to=tmp_filename, +                    ) +ifself._enough_image_difference(tmp_filename, filename): +                        copyfile(tmp_filename, filename) +                        pdf_img = filename + +# Delete temprary files +            tmp_path = Path(tmp_filename) +if Path(gettempdir()) in tmp_path.resolve().parents: +                os.close(tmp_file_handle) +                tmp_path.unlink() + +# Delete temporary SVG file - after loop as can be reused +        tmp_svg_path = Path(svg_tmp_filename) +if Path(gettempdir()) in tmp_svg_path.resolve().parents: +            os.close(svg_tmp_file_handle) +            tmp_svg_path.unlink() + diff --git a/docs/img/snippet-syntax.svg b/docs/img/snippet-syntax.svg index 8d9c8f8..edcc5df 100644 --- a/docs/img/snippet-syntax.svg +++ b/docs/img/snippet-syntax.svg @@ -19,47 +19,47 @@ font-weight: 700; } - .terminal-3073922363-matrix { + .terminal-3636095630-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3073922363-title { + .terminal-3636095630-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3073922363-r1 { fill: #f8f8f2 } -.terminal-3073922363-r2 { fill: #f92672 } -.terminal-3073922363-r3 { fill: #c5c8c6 } -.terminal-3073922363-r4 { fill: #66d9ef } -.terminal-3073922363-r5 { fill: #e6db74 } -.terminal-3073922363-r6 { fill: #ae81ff } + .terminal-3636095630-r1 { fill: #f8f8f2 } +.terminal-3636095630-r2 { fill: #f92672 } +.terminal-3636095630-r3 { fill: #c5c8c6 } +.terminal-3636095630-r4 { fill: #66d9ef } +.terminal-3636095630-r5 { fill: #e6db74 } +.terminal-3636095630-r6 { fill: #ae81ff } - + - + - + - + - + - + - + @@ -71,16 +71,16 @@ - + - - include<iostream> - -intmain(){ -std::cout<<"Hello World!"; -return0; -} - + + include<iostream> + +intmain(){ +std::cout<<"Hello World!"; +return0; +} + diff --git a/docs/img/snippet-theme-fruity.svg b/docs/img/snippet-theme-fruity.svg index 8d5ef05..3950fff 100644 --- a/docs/img/snippet-theme-fruity.svg +++ b/docs/img/snippet-theme-fruity.svg @@ -19,72 +19,72 @@ font-weight: 700; } - .terminal-2252786152-matrix { + .terminal-4128165956-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2252786152-title { + .terminal-4128165956-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2252786152-r1 { fill: #fb660a;font-weight: bold } -.terminal-2252786152-r2 { fill: #ffffff } -.terminal-2252786152-r3 { fill: #d9d9d9 } -.terminal-2252786152-r4 { fill: #008800;font-style: italic; } -.terminal-2252786152-r5 { fill: #ff0086;font-weight: bold } -.terminal-2252786152-r6 { fill: #0086d2 } -.terminal-2252786152-r7 { fill: #0086f7;font-weight: bold } + .terminal-4128165956-r1 { fill: #fb660a;font-weight: bold } +.terminal-4128165956-r2 { fill: #ffffff } +.terminal-4128165956-r3 { fill: #d9d9d9 } +.terminal-4128165956-r4 { fill: #008800;font-style: italic; } +.terminal-4128165956-r5 { fill: #ff0086;font-weight: bold } +.terminal-4128165956-r6 { fill: #0086d2 } +.terminal-4128165956-r7 { fill: #0086f7;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -96,24 +96,24 @@ - + - - fromtypingimportIterator - -# This is an example -classMath: -@staticmethod -deffib(n:int)->Iterator[int]: -""" Fibonacci series up to n """ -a,b=0,1 -whilea<n: -yielda -a,b=b,a+b - -result=sum(Math.fib(42)) -print("The answer is {}".format(result)) - + + fromtypingimportIterator + +# This is an example +classMath: +@staticmethod +deffib(n:int)->Iterator[int]: +""" Fibonacci series up to n """ +a,b=0,1 +whilea<n: +yielda +a,b=b,a+b + +result=sum(Math.fib(42)) +print("The answer is {}".format(result)) + diff --git a/docs/img/snippet-theme-monokai.svg b/docs/img/snippet-theme-monokai.svg index 4dc596d..7b92c8d 100644 --- a/docs/img/snippet-theme-monokai.svg +++ b/docs/img/snippet-theme-monokai.svg @@ -19,73 +19,73 @@ font-weight: 700; } - .terminal-2252786152-matrix { + .terminal-1976872408-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2252786152-title { + .terminal-1976872408-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2252786152-r1 { fill: #f92672 } -.terminal-2252786152-r2 { fill: #f8f8f2 } -.terminal-2252786152-r3 { fill: #c5c8c6 } -.terminal-2252786152-r4 { fill: #75715e } -.terminal-2252786152-r5 { fill: #66d9ef } -.terminal-2252786152-r6 { fill: #a6e22e } -.terminal-2252786152-r7 { fill: #e6db74 } -.terminal-2252786152-r8 { fill: #ae81ff } + .terminal-1976872408-r1 { fill: #f92672 } +.terminal-1976872408-r2 { fill: #f8f8f2 } +.terminal-1976872408-r3 { fill: #c5c8c6 } +.terminal-1976872408-r4 { fill: #75715e } +.terminal-1976872408-r5 { fill: #66d9ef } +.terminal-1976872408-r6 { fill: #a6e22e } +.terminal-1976872408-r7 { fill: #e6db74 } +.terminal-1976872408-r8 { fill: #ae81ff } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -97,24 +97,24 @@ - + - - fromtypingimportIterator - -# This is an example -classMath: -@staticmethod -deffib(n:int)->Iterator[int]: -""" Fibonacci series up to n """ -a,b=0,1 -whilea<n: -yielda -a,b=b,a+b - -result=sum(Math.fib(42)) -print("The answer is {}".format(result)) - + + fromtypingimportIterator + +# This is an example +classMath: +@staticmethod +deffib(n:int)->Iterator[int]: +""" Fibonacci series up to n """ +a,b=0,1 +whilea<n: +yielda +a,b=b,a+b + +result=sum(Math.fib(42)) +print("The answer is {}".format(result)) + diff --git a/docs/img/snippet-theme-sas.svg b/docs/img/snippet-theme-sas.svg index 081e4e6..529e020 100644 --- a/docs/img/snippet-theme-sas.svg +++ b/docs/img/snippet-theme-sas.svg @@ -19,71 +19,71 @@ font-weight: 700; } - .terminal-2252786152-matrix { + .terminal-102356505-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2252786152-title { + .terminal-102356505-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2252786152-r1 { fill: #2c2cff } -.terminal-2252786152-r2 { fill: #000000 } -.terminal-2252786152-r3 { fill: #008800;font-style: italic; } -.terminal-2252786152-r4 { fill: #000000;font-weight: bold;font-style: italic; } -.terminal-2252786152-r5 { fill: #800080 } -.terminal-2252786152-r6 { fill: #2c8553;font-weight: bold } + .terminal-102356505-r1 { fill: #2c2cff } +.terminal-102356505-r2 { fill: #000000 } +.terminal-102356505-r3 { fill: #008800;font-style: italic; } +.terminal-102356505-r4 { fill: #000000;font-weight: bold;font-style: italic; } +.terminal-102356505-r5 { fill: #800080 } +.terminal-102356505-r6 { fill: #2c8553;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -95,24 +95,24 @@ - + - - fromtypingimportIterator - -# This is an example -classMath: -@staticmethod -deffib(n:int)->Iterator[int]: -""" Fibonacci series up to n """ -a,b=0,1 -whilea<n: -yielda -a,b=b,a+b - -result=sum(Math.fib(42)) -print("The answer is {}".format(result)) - + + fromtypingimportIterator + +# This is an example +classMath: +@staticmethod +deffib(n:int)->Iterator[int]: +""" Fibonacci series up to n """ +a,b=0,1 +whilea<n: +yielda +a,b=b,a+b + +result=sum(Math.fib(42)) +print("The answer is {}".format(result)) + diff --git a/docs/img/taste-the-rainbow.svg b/docs/img/taste-the-rainbow.svg index 3e8fd03..5569018 100644 --- a/docs/img/taste-the-rainbow.svg +++ b/docs/img/taste-the-rainbow.svg @@ -19,94 +19,94 @@ font-weight: 700; } - .terminal-2852800659-matrix { + .terminal-2548273007-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2852800659-title { + .terminal-2548273007-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2852800659-r1 { fill: #d9d9d9 } -.terminal-2852800659-r2 { fill: #5f5fff } -.terminal-2852800659-r3 { fill: #5f87ff } -.terminal-2852800659-r4 { fill: #0087ff } -.terminal-2852800659-r5 { fill: #00afff } -.terminal-2852800659-r6 { fill: #00afd7 } -.terminal-2852800659-r7 { fill: #00d7d7 } -.terminal-2852800659-r8 { fill: #00d7af } -.terminal-2852800659-r9 { fill: #00ffaf } -.terminal-2852800659-r10 { fill: #00ff87 } -.terminal-2852800659-r11 { fill: #5fff87 } -.terminal-2852800659-r12 { fill: #5fff5f } + .terminal-2548273007-r1 { fill: #d9d9d9 } +.terminal-2548273007-r2 { fill: #5f5fff } +.terminal-2548273007-r3 { fill: #5f87ff } +.terminal-2548273007-r4 { fill: #0087ff } +.terminal-2548273007-r5 { fill: #00afff } +.terminal-2548273007-r6 { fill: #00afd7 } +.terminal-2548273007-r7 { fill: #00d7d7 } +.terminal-2548273007-r8 { fill: #00d7af } +.terminal-2548273007-r9 { fill: #00ffaf } +.terminal-2548273007-r10 { fill: #00ff87 } +.terminal-2548273007-r11 { fill: #5fff87 } +.terminal-2548273007-r12 { fill: #5fff5f } - + - + - + - + - + - + - + - + - + - + - + - + - Taste the rainbow + Taste the rainbow - + - - $ cowsay "Taste the rainbow" | lolcat -S 100 -_________________ -|Tastetherainbow| -================= -\ -\ -^__^ -(oo)\_______ -(__)\)\/\ -||----w| -|||| - + + $ cowsay "Taste the rainbow" | lolcat -S 100 +_________________ +|Tastetherainbow| +================= +\ +\ +^__^ +(oo)\_______ +(__)\)\/\ +||----w| +|||| + diff --git a/docs/img/theme-default_terminal_theme.svg b/docs/img/theme-default_terminal_theme.svg index 51203a3..79a2770 100644 --- a/docs/img/theme-default_terminal_theme.svg +++ b/docs/img/theme-default_terminal_theme.svg @@ -19,63 +19,63 @@ font-weight: 700; } - .terminal-1443119455-matrix { + .terminal-4165195828-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1443119455-title { + .terminal-4165195828-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1443119455-r1 { fill: #000000 } -.terminal-1443119455-r2 { fill: #0000ff } -.terminal-1443119455-r3 { fill: #00ffff } -.terminal-1443119455-r4 { fill: #808080 } -.terminal-1443119455-r5 { fill: #808000 } + .terminal-4165195828-r1 { fill: #000000 } +.terminal-4165195828-r2 { fill: #0000ff } +.terminal-4165195828-r3 { fill: #00ffff } +.terminal-4165195828-r4 { fill: #808080 } +.terminal-4165195828-r5 { fill: #808000 } - + - + - + - + - + - + - DEFAULT_TERMINAL_THEME + DEFAULT_TERMINAL_THEME - + - - $ rich ../../setup.cfg -h 5 --force-terminal -[metadata] -name=rich-codex -version=attr: rich_codex.__version__ -url=https://github.com/ewels/rich-codex -project_urls= + + $ rich ../../setup.cfg -h 5 --force-terminal +[metadata] +name=rich-codex +version=attr: rich_codex.__version__ +url=https://github.com/ewels/rich-codex +project_urls= diff --git a/docs/img/theme-dimmed_monokai.svg b/docs/img/theme-dimmed_monokai.svg index be7494b..e5ba1ab 100644 --- a/docs/img/theme-dimmed_monokai.svg +++ b/docs/img/theme-dimmed_monokai.svg @@ -19,63 +19,63 @@ font-weight: 700; } - .terminal-1392787178-matrix { + .terminal-1046468031-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1392787178-title { + .terminal-1046468031-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1392787178-r1 { fill: #b9bcba } -.terminal-1392787178-r2 { fill: #186de3 } -.terminal-1392787178-r3 { fill: #2e706d } -.terminal-1392787178-r4 { fill: #888987 } -.terminal-1392787178-r5 { fill: #c5a635 } + .terminal-1046468031-r1 { fill: #b9bcba } +.terminal-1046468031-r2 { fill: #186de3 } +.terminal-1046468031-r3 { fill: #2e706d } +.terminal-1046468031-r4 { fill: #888987 } +.terminal-1046468031-r5 { fill: #c5a635 } - + - + - + - + - + - + - DIMMED_MONOKAI + DIMMED_MONOKAI - + - - $ rich ../../setup.cfg -h 5 --force-terminal -[metadata] -name=rich-codex -version=attr: rich_codex.__version__ -url=https://github.com/ewels/rich-codex -project_urls= + + $ rich ../../setup.cfg -h 5 --force-terminal +[metadata] +name=rich-codex +version=attr: rich_codex.__version__ +url=https://github.com/ewels/rich-codex +project_urls= diff --git a/docs/img/theme-monokai.svg b/docs/img/theme-monokai.svg index 5bc06d5..0e5636f 100644 --- a/docs/img/theme-monokai.svg +++ b/docs/img/theme-monokai.svg @@ -19,63 +19,63 @@ font-weight: 700; } - .terminal-2699377883-matrix { + .terminal-1815204784-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2699377883-title { + .terminal-1815204784-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2699377883-r1 { fill: #d9d9d9 } -.terminal-2699377883-r2 { fill: #9d65ff } -.terminal-2699377883-r3 { fill: #58d1eb } -.terminal-2699377883-r4 { fill: #625e4c } -.terminal-2699377883-r5 { fill: #fd971f } + .terminal-1815204784-r1 { fill: #d9d9d9 } +.terminal-1815204784-r2 { fill: #9d65ff } +.terminal-1815204784-r3 { fill: #58d1eb } +.terminal-1815204784-r4 { fill: #625e4c } +.terminal-1815204784-r5 { fill: #fd971f } - + - + - + - + - + - + - MONOKAI + MONOKAI - + - - $ rich ../../setup.cfg -h 5 --force-terminal -[metadata] -name=rich-codex -version=attr: rich_codex.__version__ -url=https://github.com/ewels/rich-codex -project_urls= + + $ rich ../../setup.cfg -h 5 --force-terminal +[metadata] +name=rich-codex +version=attr: rich_codex.__version__ +url=https://github.com/ewels/rich-codex +project_urls= diff --git a/docs/img/theme-night_owlish.svg b/docs/img/theme-night_owlish.svg index 1382701..fda6284 100644 --- a/docs/img/theme-night_owlish.svg +++ b/docs/img/theme-night_owlish.svg @@ -19,63 +19,63 @@ font-weight: 700; } - .terminal-3597287036-matrix { + .terminal-2483869009-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3597287036-title { + .terminal-2483869009-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3597287036-r1 { fill: #403f53 } -.terminal-3597287036-r2 { fill: #5ca7e4 } -.terminal-3597287036-r3 { fill: #00c990 } -.terminal-3597287036-r4 { fill: #7a8181 } -.terminal-3597287036-r5 { fill: #daaa01 } + .terminal-2483869009-r1 { fill: #403f53 } +.terminal-2483869009-r2 { fill: #5ca7e4 } +.terminal-2483869009-r3 { fill: #00c990 } +.terminal-2483869009-r4 { fill: #7a8181 } +.terminal-2483869009-r5 { fill: #daaa01 } - + - + - + - + - + - + - NIGHT_OWLISH + NIGHT_OWLISH - + - - $ rich ../../setup.cfg -h 5 --force-terminal -[metadata] -name=rich-codex -version=attr: rich_codex.__version__ -url=https://github.com/ewels/rich-codex -project_urls= + + $ rich ../../setup.cfg -h 5 --force-terminal +[metadata] +name=rich-codex +version=attr: rich_codex.__version__ +url=https://github.com/ewels/rich-codex +project_urls= diff --git a/docs/img/theme-svg_export_theme.svg b/docs/img/theme-svg_export_theme.svg index 8e63630..c8a3259 100644 --- a/docs/img/theme-svg_export_theme.svg +++ b/docs/img/theme-svg_export_theme.svg @@ -19,63 +19,63 @@ font-weight: 700; } - .terminal-3577167824-matrix { + .terminal-3997947557-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3577167824-title { + .terminal-3997947557-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3577167824-r1 { fill: #c5c8c6 } -.terminal-3577167824-r2 { fill: #1984e9 } -.terminal-3577167824-r3 { fill: #398280 } -.terminal-3577167824-r4 { fill: #9a9b99 } -.terminal-3577167824-r5 { fill: #d0b344 } + .terminal-3997947557-r1 { fill: #c5c8c6 } +.terminal-3997947557-r2 { fill: #1984e9 } +.terminal-3997947557-r3 { fill: #398280 } +.terminal-3997947557-r4 { fill: #9a9b99 } +.terminal-3997947557-r5 { fill: #d0b344 } - + - + - + - + - + - + - SVG_EXPORT_THEME + SVG_EXPORT_THEME - + - - $ rich ../../setup.cfg -h 5 --force-terminal -[metadata] -name=rich-codex -version=attr: rich_codex.__version__ -url=https://github.com/ewels/rich-codex -project_urls= + + $ rich ../../setup.cfg -h 5 --force-terminal +[metadata] +name=rich-codex +version=attr: rich_codex.__version__ +url=https://github.com/ewels/rich-codex +project_urls= diff --git a/docs/img/title-command-default.svg b/docs/img/title-command-default.svg index f199db5..11876b4 100644 --- a/docs/img/title-command-default.svg +++ b/docs/img/title-command-default.svg @@ -19,27 +19,27 @@ font-weight: 700; } - .terminal-2523074728-matrix { + .terminal-4270989296-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2523074728-title { + .terminal-4270989296-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2523074728-r1 { fill: #c5c8c6 } + .terminal-4270989296-r1 { fill: #c5c8c6 } - + - + @@ -51,11 +51,11 @@ - + - - $ echo "No custom title set" -No custom title set + + $ echo "No custom title set" +No custom title set diff --git a/docs/img/title-command.svg b/docs/img/title-command.svg index de5e05c..93a8f94 100644 --- a/docs/img/title-command.svg +++ b/docs/img/title-command.svg @@ -19,43 +19,43 @@ font-weight: 700; } - .terminal-2861438133-matrix { + .terminal-4054852605-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2861438133-title { + .terminal-4054852605-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2861438133-r1 { fill: #c5c8c6 } + .terminal-4054852605-r1 { fill: #c5c8c6 } - + - + - echo "Look ma, a title" + echo "Look ma, a title" - + - - $ echo "Look ma, a title" -Look ma, a title + + $ echo "Look ma, a title" +Look ma, a title diff --git a/docs/img/trim-after_truncated-text.svg b/docs/img/trim-after_truncated-text.svg index 7be8d68..081c925 100644 --- a/docs/img/trim-after_truncated-text.svg +++ b/docs/img/trim-after_truncated-text.svg @@ -19,111 +19,111 @@ font-weight: 700; } - .terminal-2403310259-matrix { + .terminal-595930094-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-2403310259-title { + .terminal-595930094-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-2403310259-r1 { fill: #c5c8c6 } + .terminal-595930094-r1 { fill: #c5c8c6 } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - codex_search.py + codex_search.py - + - - $ rich ../../src/rich_codex/codex_search.py -import logging -import re -from pathlib import Path - -import yaml -from jsonschema.exceptions import ValidationError -from rich import box -from rich.console import Console -from rich.prompt import Prompt -from rich.table import Table - -from rich_codex import rich_img -from rich_codex.utils import validate_config - -log = logging.getLogger("rich-codex") - - -class CodexSearch: + + $ rich ../../src/rich_codex/codex_search.py +import logging +import re +from pathlib import Path + +import yaml +from jsonschema.exceptions import ValidationError +from rich import box +from rich.console import Console +from rich.prompt import Prompt +from rich.table import Table + +from rich_codex import rich_img +from rich_codex.utils import validate_config + +log = logging.getLogger("rich-codex") + + +class CodexSearch: