Skip to content

Configuration Options

Configuration is stored in NUON format at $XDG_CONFIG_HOME/stars/config.nu.

Access any key with dot notation: stars config get <key>

KeyTypeDefaultDescription
versionstring"3.0.0"Config schema version
KeyTypeDefaultDescription
storage.db_pathpath?nullCustom database path. null = use XDG default.
storage.backup_on_syncboolfalseAuto-backup before every sync
KeyTypeDefaultDescription
defaults.columnslist<string>[owner, name, language, stars, pushed, homepage, topics, description, forks, issues]Columns shown in table output
defaults.sort_bystring"stars"Default sort field. Options: stars, forks, pushed, created, updated, name, language, owner
defaults.sort_reversebooltrueReverse sort order (true = descending)
KeyTypeDefaultDescription
defaults.filters.exclude_languageslist<string>[PHP, "C#", Java, Python, Ruby]Languages to exclude from default view
defaults.filters.exclude_archivedbooltrueHide archived repositories
defaults.filters.exclude_forksboolfalseHide forked repositories
defaults.filters.min_pushed_daysint365Exclude repos not pushed in this many days
KeyTypeDefaultDescription
output.default_formatstring"table"Default output format
KeyTypeDefaultDescription
output.table.max_description_lengthint80Truncate descriptions longer than this
output.table.clickable_linksbooltrueRender clickable terminal hyperlinks
output.table.colorize_languagesbooltrueColor-code language names
KeyTypeDefaultDescription
sync.sourceslist<string>[github]Active sync sources
KeyTypeDefaultDescription
sync.github.per_pageint100Stars per API page (max: 100)
sync.github.cache_durationstring"1h"gh CLI cache TTL
sync.github.full_sync_interval_daysint7Days between auto full syncs
Terminal window
{
version: "3.0.0"
storage: {
db_path: null
backup_on_sync: false
}
defaults: {
filters: {
exclude_languages: [PHP, "C#", Java, Python, Ruby]
exclude_archived: true
exclude_forks: false
min_pushed_days: 365
}
columns: [owner, name, language, stars, pushed, homepage, topics, description, forks, issues]
sort_by: "stars"
sort_reverse: true
}
output: {
default_format: "table"
table: {
max_description_length: 80
clickable_links: true
colorize_languages: true
}
}
sync: {
sources: [github]
github: {
per_page: 100
cache_duration: "1h"
full_sync_interval_days: 7
}
}
}