npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

astrolark

v0.3.8

Published

Generate context for an LLM to ask it questions on a project

Downloads

78

Readme

🚀 Astrolark

TL;DR

Astrolark is a command-line tool that snapshots your project's structure and contents. Run npx astrolark in your project folder to start the interactive wizard, or use the non-interactive mode with command-line options. It automatically copies the overview to your clipboard or saves it to a file. Then, simply open your preferred AI assistant (like ChatGPT or Claude) in a web browser, paste the content, and start asking questions about your code. It's an effortless way to get AI insights on your project.

Beam Up Your Code, Captain! 🖖

Astrolark is your trusty command-line companion for exploring and extracting the essence of your code base. Like the probes from sci-fi classics, it dives deep into your project, retrieves valuable information, and prepares it for your next mission - whether that's collaborating with AI or sharing with your crew.

🌟 Features

  • Warp-speed Scanning: Beam up your entire project structure and file contents faster than you can say "Engage!"
  • AI-Ready Output: Prepare your code for seamless integration with LLMs like Claude, ChatGPT, or Gemini
  • Mootta-Compatible: Fits perfectly into your toolkit for Project Mootta workflows
  • Format Options: Choose between YAML and XML output formats
  • Clipboard Integration: Automatically copy the generated overview to your clipboard
  • Gitignore Respect: Excludes files and directories based on your .gitignore rules
  • Binary File Detection: Automatically skips binary files to keep your overview clean
  • Interactive Wizard: Easy configuration with a user-friendly command-line interface
  • Non-Interactive Mode: Use command-line options for quick scans without the wizard
  • File and Directory Filtering: Specify which files or directories to include in the overview

🛸 Quick Start

Run Astrolark in your project directory:

npx astrolark

This will start the interactive wizard to guide you through the configuration options.

💫 Advanced Usage

Skip the wizard and use command-line options for quick scans:

npx astrolark read --verbose --output project_overview.astrolark.yaml --base-path "/path/to/project" --filter "src" "tests" --no-wizard

Available options:

  • read or edit: Specify the command (required)
  • --no-wizard: Skip the interactive wizard
  • --verbose: Enable verbose output for debugging
  • --output <filename>: Set a custom output filename (for 'read' command)
  • --base-path <path>: Specify the base path for file operations
  • --filter <path>...: Specify files or directories to include (can be used multiple times)

🌠 Why Astrolark?

In the vast universe of development tools, Astrolark stands out as your reliable probe, designed to:

  1. Simplify code sharing and analysis
  2. Boost productivity in AI-assisted workflows
  3. Enhance collaboration across galaxies (or just teams)
  4. Provide a quick, comprehensive view of your project

👽 Join the Crew

Found a glitch in the matrix? Have ideas for new features? We welcome all species to contribute!

📡 Stay in Orbit

  • Follow the