Skip to content

Add llms.txt for LLM/agent-readable project summary #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abyworkings-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add llms.txt for LLM/agent-readable project summary #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# npkill

> A CLI tool to list `node_modules` directories anywhere on your system, show how much disk space each one uses, and interactively select and delete them to reclaim space.

## Getting Started

- [Installation](https://github.com/voidcosmos/npkill#installation): `npx npkill` (no install needed) or `npm i -g npkill`.
- [Usage](https://github.com/voidcosmos/npkill#usage): Interactive controls (arrow keys, Space/Del to delete, search mode, multi-select mode).
- [Options](https://github.com/voidcosmos/npkill#options): Full CLI flag reference (`-d`/`--directory`, `-e`/`--exclude`, `-x`/`--exclude-sensitive`, `--dry-run`, `--json`, `--json-stream`, etc.).
- [Examples](https://github.com/voidcosmos/npkill#examples): Common invocations for scanning specific paths, excluding directories, and automated deletion.

## Configuration

- [Profiles](https://github.com/voidcosmos/npkill/blob/master/docs/profiles.md): Predefined target sets selectable with `-p`/`--profiles`.
- [.npkillrc config file](https://github.com/voidcosmos/npkill/blob/master/docs/npkillrc.md): Persistent configuration, loaded from `./.npkillrc` or `~/.npkillrc`.
- [JSON output](https://github.com/voidcosmos/npkill/blob/master/docs/json-output.md): `--json` and `--json-stream` formats for scripting/automation, with TypeScript interfaces.

## Development

- [Set up locally](https://github.com/voidcosmos/npkill#set-up-locally): Clone, `npm install`, `npm run start`.
- [Node.js API](https://github.com/voidcosmos/npkill/blob/master/API.md): The `Npkill` interface (`startScan$`, `getSize$`, `delete$`, etc.) for embedding npkill in scripts.
- [Contributing](https://github.com/voidcosmos/npkill/blob/master/.github/CONTRIBUTING.md): Contribution guidelines.

## Optional

- [Roadmap](https://github.com/voidcosmos/npkill#roadmap): Planned and completed features.
- [License](https://github.com/voidcosmos/npkill/blob/master/LICENSE): MIT.