Skip to content
stars.nu

Quick Start

A five-minute walkthrough from zero to browsing your starred repos.

  1. Load the module

    Terminal window
    use ~/.config/nushell/modules/stars *

  2. Sync your GitHub stars

    Terminal window
    stars sync

    This fetches all your starred repositories from GitHub and stores them in a local SQLite database. The first sync fetches everything; subsequent syncs are incremental.

  3. Browse your stars

    Terminal window
    stars

    Displays a formatted table with owner, name, language, stars, last push date, and more.

  4. Search for something

    Terminal window
    stars "rust cli"

    Searches across repo names, descriptions, and topics.

  5. Export to a file

    Terminal window
    stars export json --pretty

    Saves a JSON file to $XDG_DATA_HOME/.stars/exports/.

What just happened?

Section titled “What just happened?”
  • stars sync called the GitHub API via gh api, paginated through all your stars, and stored them in ~/.local/share/.stars/stars.db
  • stars loaded the SQLite database, applied default filters (excluding archived repos, stale repos, and certain languages), sorted by star count, and rendered a table
  • stars "rust cli" did the same but additionally filtered to repos matching your query
  • stars export json wrote the full dataset to a timestamped JSON file

Next steps

Section titled “Next steps”