Skip to content

stars config

The config commands manage your stars.nu settings, stored in NUON format at $XDG_CONFIG_HOME/stars/config.nu.

Shows the current configuration as a Nushell record.

Terminal window
stars config
stars config --json

Creates a configuration file with default values.

Terminal window
stars config init
stars config init --force # overwrite existing
FlagDescription
--forceOverwrite existing configuration file

Alias for stars config. Shows the current configuration.

Terminal window
stars config show
stars config show --json

Retrieves a specific value using dot notation for nested keys.

Terminal window
stars config get version
# => "3.0.0"
stars config get defaults.columns
# => [owner, name, language, stars, pushed, homepage, topics, description, forks, issues]
stars config get defaults.filters.exclude_languages
# => [PHP, C#, Java, Python, Ruby]
stars config get sync.github.per_page
# => 100
stars config get output.table.clickable_links
# => true

Sets a value using dot notation. Creates intermediate keys if they don’t exist.

Terminal window
stars config set defaults.sort_by "pushed"
stars config set output.table.max_description_length 120
stars config set defaults.filters.exclude_archived false
stars config set sync.github.full_sync_interval_days 14

Resets configuration to defaults. Optionally reset only a specific key.

Terminal window
# Reset everything
stars config reset
# Reset only the filters section
stars config reset --key defaults.filters
FlagTypeDescription
--keystringSpecific key to reset (dot notation). Resets all if omitted.

Opens the configuration file in your editor ($EDITOR or $VISUAL, defaults to nvim). Creates a default config first if none exists.

Terminal window
stars config edit

Returns the path to the configuration file.

Terminal window
stars config path
# => /home/user/.config/stars/config.nu

Checks the configuration for structural issues and reports errors/warnings.

Terminal window
stars config validate

Returns a record:

╭──────────┬──────────────────────╮
│ valid │ true │
│ errors │ [] │
│ warnings │ [] │
╰──────────┴──────────────────────╯

Checks for: version field, storage section, defaults section (with columns and filters), output section, and sync section.