github_repo

Repo identity for the current directory: slug, description, and SPDX license. Use github_repo_stars instead for the social counters (stars, forks, watchers).

Kind	Safety	Shapes
cached	Safe	entries, text_block, text

Options

Option	Type	Required	Default	Description
repo	"owner/name"	no	git remote of cwd	Repository to query. Falls back to the current directory's github remote.

Compatible renderers

Shape	Renderers
entries	animated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, grid_table
text_block	animated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, list_plain
text	animated_boot, animated_figlet_morph, animated_postfx, animated_scanlines, animated_splitflap, animated_typewriter, animated_wave, text_ascii, text_plain

Preview

entries via grid_table

slug           unhappychoice/splashboard
description     terminal splash renderer
license                              ISC
                                        
                                        

[[widget]]
id = "github_repo"
fetcher = "github_repo"
render = "grid_table"

text_block via list_plain

unhappychoice/splashboard               
terminal splash renderer                
ISC                                     
                                        

[[widget]]
id = "github_repo"
fetcher = "github_repo"
render = "list_plain"

text via text_ascii

        ▜▌                      ▜▌       ▀            ▟▘        ▝█          ▜▌  
█ █ █▀▙ ▐▙▜▖▝▀▙ ▜▞▜▖▜▞▜▖█ █ ▟▀▙ ▐▙▜▖▟▀▙ ▝█  ▟▀▙ ▟▀▙  ▟▘ ▟▀▀ ▜▞▜▖ █  ▝▀▙ ▟▀▀ ▐▙▜▖
█ █ █ █ ▐▌▐▌▟▀█ ▐▙▟▘▐▙▟▘▜▄█ █ ▄ ▐▌▐▌█ █  █  █ ▄ █▀▀ ▟▘  ▝▀▙ ▐▙▟▘ █  ▟▀█ ▝▀▙ ▐▌▐▌
▝▀▝▘▀ ▀ ▀▘▝▘▝▀▝▘▟▙  ▟▙  ▄▄▛ ▝▀▘ ▀▘▝▘▝▀▘ ▝▀▘ ▝▀▘ ▝▀▘ ▘   ▀▀▘ ▟▙  ▝▀▘ ▝▀▝▘▀▀▘ ▀▘▝▘
                                                                                

[[widget]]
id = "github_repo"
fetcher = "github_repo"
render = "text_ascii"

text via text_plain

unhappychoice/splashboard · terminal spl
                                        

[[widget]]
id = "github_repo"
fetcher = "github_repo"
render = "text_plain"